:py:mod:`mass_driver.models.repository`
=======================================

.. py:module:: mass_driver.models.repository

.. autodoc2-docstring:: mass_driver.models.repository
   :parser: myst
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`SourcedRepo <mass_driver.models.repository.SourcedRepo>`
     - .. autodoc2-docstring:: mass_driver.models.repository.SourcedRepo
          :parser: myst
          :summary:
   * - :py:obj:`ClonedRepo <mass_driver.models.repository.ClonedRepo>`
     - .. autodoc2-docstring:: mass_driver.models.repository.ClonedRepo
          :parser: myst
          :summary:
   * - :py:obj:`Source <mass_driver.models.repository.Source>`
     - .. autodoc2-docstring:: mass_driver.models.repository.Source
          :parser: myst
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`BranchName <mass_driver.models.repository.BranchName>`
     - .. autodoc2-docstring:: mass_driver.models.repository.BranchName
          :parser: myst
          :summary:
   * - :py:obj:`RepoID <mass_driver.models.repository.RepoID>`
     - .. autodoc2-docstring:: mass_driver.models.repository.RepoID
          :parser: myst
          :summary:
   * - :py:obj:`RepoUrl <mass_driver.models.repository.RepoUrl>`
     - .. autodoc2-docstring:: mass_driver.models.repository.RepoUrl
          :parser: myst
          :summary:
   * - :py:obj:`IndexedRepos <mass_driver.models.repository.IndexedRepos>`
     - .. autodoc2-docstring:: mass_driver.models.repository.IndexedRepos
          :parser: myst
          :summary:
   * - :py:obj:`IndexedClonedRepos <mass_driver.models.repository.IndexedClonedRepos>`
     - .. autodoc2-docstring:: mass_driver.models.repository.IndexedClonedRepos
          :parser: myst
          :summary:

API
~~~

.. py:data:: BranchName
   :canonical: mass_driver.models.repository.BranchName
   :value: None

   .. autodoc2-docstring:: mass_driver.models.repository.BranchName
      :parser: myst

.. py:data:: RepoID
   :canonical: mass_driver.models.repository.RepoID
   :value: None

   .. autodoc2-docstring:: mass_driver.models.repository.RepoID
      :parser: myst

.. py:data:: RepoUrl
   :canonical: mass_driver.models.repository.RepoUrl
   :value: None

   .. autodoc2-docstring:: mass_driver.models.repository.RepoUrl
      :parser: myst

.. py:class:: SourcedRepo
   :canonical: mass_driver.models.repository.SourcedRepo

   Bases: :py:obj:`pydantic.BaseModel`

   .. autodoc2-docstring:: mass_driver.models.repository.SourcedRepo
      :parser: myst

   .. py:attribute:: clone_url
      :canonical: mass_driver.models.repository.SourcedRepo.clone_url
      :type: mass_driver.models.repository.RepoUrl
      :value: None

      .. autodoc2-docstring:: mass_driver.models.repository.SourcedRepo.clone_url
         :parser: myst

   .. py:attribute:: repo_id
      :canonical: mass_driver.models.repository.SourcedRepo.repo_id
      :type: mass_driver.models.repository.RepoID
      :value: None

      .. autodoc2-docstring:: mass_driver.models.repository.SourcedRepo.repo_id
         :parser: myst

   .. py:attribute:: upstream_branch
      :canonical: mass_driver.models.repository.SourcedRepo.upstream_branch
      :type: mass_driver.models.repository.BranchName | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.repository.SourcedRepo.upstream_branch
         :parser: myst

   .. py:attribute:: force_pull
      :canonical: mass_driver.models.repository.SourcedRepo.force_pull
      :type: bool
      :value: False

      .. autodoc2-docstring:: mass_driver.models.repository.SourcedRepo.force_pull
         :parser: myst

   .. py:attribute:: patch_data
      :canonical: mass_driver.models.repository.SourcedRepo.patch_data
      :type: dict
      :value: None

      .. autodoc2-docstring:: mass_driver.models.repository.SourcedRepo.patch_data
         :parser: myst

.. py:class:: ClonedRepo
   :canonical: mass_driver.models.repository.ClonedRepo

   Bases: :py:obj:`mass_driver.models.repository.SourcedRepo`

   .. autodoc2-docstring:: mass_driver.models.repository.ClonedRepo
      :parser: myst

   .. py:attribute:: cloned_path
      :canonical: mass_driver.models.repository.ClonedRepo.cloned_path
      :type: pydantic.DirectoryPath
      :value: None

      .. autodoc2-docstring:: mass_driver.models.repository.ClonedRepo.cloned_path
         :parser: myst

   .. py:attribute:: current_branch
      :canonical: mass_driver.models.repository.ClonedRepo.current_branch
      :type: mass_driver.models.repository.BranchName
      :value: None

      .. autodoc2-docstring:: mass_driver.models.repository.ClonedRepo.current_branch
         :parser: myst

.. py:data:: IndexedRepos
   :canonical: mass_driver.models.repository.IndexedRepos
   :value: None

   .. autodoc2-docstring:: mass_driver.models.repository.IndexedRepos
      :parser: myst

.. py:data:: IndexedClonedRepos
   :canonical: mass_driver.models.repository.IndexedClonedRepos
   :value: None

   .. autodoc2-docstring:: mass_driver.models.repository.IndexedClonedRepos
      :parser: myst

.. py:class:: Source
   :canonical: mass_driver.models.repository.Source

   Bases: :py:obj:`pydantic.BaseSettings`

   .. autodoc2-docstring:: mass_driver.models.repository.Source
      :parser: myst

   .. py:method:: discover() -> mass_driver.models.repository.IndexedRepos
      :canonical: mass_driver.models.repository.Source.discover
      :abstractmethod:

      .. autodoc2-docstring:: mass_driver.models.repository.Source.discover
         :parser: myst

   .. py:class:: Config
      :canonical: mass_driver.models.repository.Source.Config

      .. autodoc2-docstring:: mass_driver.models.repository.Source.Config
         :parser: myst

      .. py:attribute:: underscore_attrs_are_private
         :canonical: mass_driver.models.repository.Source.Config.underscore_attrs_are_private
         :value: True

         .. autodoc2-docstring:: mass_driver.models.repository.Source.Config.underscore_attrs_are_private
            :parser: myst

      .. py:attribute:: env_prefix
         :canonical: mass_driver.models.repository.Source.Config.env_prefix
         :value: 'SOURCE_'

         .. autodoc2-docstring:: mass_driver.models.repository.Source.Config.env_prefix
            :parser: myst