:py:mod:`mass_driver.forges.github`
===================================

.. py:module:: mass_driver.forges.github

.. autodoc2-docstring:: mass_driver.forges.github
   :parser: myst
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`GithubBaseForge <mass_driver.forges.github.GithubBaseForge>`
     - .. autodoc2-docstring:: mass_driver.forges.github.GithubBaseForge
          :parser: myst
          :summary:
   * - :py:obj:`GithubPersonalForge <mass_driver.forges.github.GithubPersonalForge>`
     - .. autodoc2-docstring:: mass_driver.forges.github.GithubPersonalForge
          :parser: myst
          :summary:
   * - :py:obj:`GithubAppForge <mass_driver.forges.github.GithubAppForge>`
     - .. autodoc2-docstring:: mass_driver.forges.github.GithubAppForge
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`detect_github_repo <mass_driver.forges.github.detect_github_repo>`
     - .. autodoc2-docstring:: mass_driver.forges.github.detect_github_repo
          :parser: myst
          :summary:
   * - :py:obj:`detect_pr_info <mass_driver.forges.github.detect_pr_info>`
     - .. autodoc2-docstring:: mass_driver.forges.github.detect_pr_info
          :parser: myst
          :summary:

API
~~~

.. py:class:: GithubBaseForge
   :canonical: mass_driver.forges.github.GithubBaseForge

   Bases: :py:obj:`mass_driver.models.forge.Forge`

   .. autodoc2-docstring:: mass_driver.forges.github.GithubBaseForge
      :parser: myst

   .. py:attribute:: _github_api
      :canonical: mass_driver.forges.github.GithubBaseForge._github_api
      :type: github.Github
      :value: None

      .. autodoc2-docstring:: mass_driver.forges.github.GithubBaseForge._github_api
         :parser: myst

   .. py:method:: create_pr(forge_repo_url: str, base_branch: mass_driver.models.forge.BranchName, head_branch: mass_driver.models.forge.BranchName, pr_title: str, pr_body: str, draft: bool)
      :canonical: mass_driver.forges.github.GithubBaseForge.create_pr

      .. autodoc2-docstring:: mass_driver.forges.github.GithubBaseForge.create_pr
         :parser: myst

   .. py:method:: get_pr_status(pr_url: str) -> str
      :canonical: mass_driver.forges.github.GithubBaseForge.get_pr_status

      .. autodoc2-docstring:: mass_driver.forges.github.GithubBaseForge.get_pr_status
         :parser: myst

   .. py:property:: pr_statuses
      :canonical: mass_driver.forges.github.GithubBaseForge.pr_statuses
      :type: list[str]

      .. autodoc2-docstring:: mass_driver.forges.github.GithubBaseForge.pr_statuses
         :parser: myst

   .. py:method:: _get_pr(forge_repo: str, pr_id: str)
      :canonical: mass_driver.forges.github.GithubBaseForge._get_pr

      .. autodoc2-docstring:: mass_driver.forges.github.GithubBaseForge._get_pr
         :parser: myst

.. py:class:: GithubPersonalForge(**data)
   :canonical: mass_driver.forges.github.GithubPersonalForge

   Bases: :py:obj:`mass_driver.forges.github.GithubBaseForge`

   .. autodoc2-docstring:: mass_driver.forges.github.GithubPersonalForge
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: mass_driver.forges.github.GithubPersonalForge.__init__
      :parser: myst

   .. py:attribute:: token
      :canonical: mass_driver.forges.github.GithubPersonalForge.token
      :type: pydantic.SecretStr
      :value: None

      .. autodoc2-docstring:: mass_driver.forges.github.GithubPersonalForge.token
         :parser: myst

.. py:class:: GithubAppForge(**data)
   :canonical: mass_driver.forges.github.GithubAppForge

   Bases: :py:obj:`mass_driver.forges.github.GithubBaseForge`

   .. autodoc2-docstring:: mass_driver.forges.github.GithubAppForge
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: mass_driver.forges.github.GithubAppForge.__init__
      :parser: myst

   .. py:attribute:: app_id
      :canonical: mass_driver.forges.github.GithubAppForge.app_id
      :type: pydantic.SecretStr
      :value: None

      .. autodoc2-docstring:: mass_driver.forges.github.GithubAppForge.app_id
         :parser: myst

   .. py:attribute:: app_private_key
      :canonical: mass_driver.forges.github.GithubAppForge.app_private_key
      :type: pydantic.SecretStr
      :value: None

      .. autodoc2-docstring:: mass_driver.forges.github.GithubAppForge.app_private_key
         :parser: myst

   .. py:attribute:: app_installation_id
      :canonical: mass_driver.forges.github.GithubAppForge.app_installation_id
      :type: int
      :value: None

      .. autodoc2-docstring:: mass_driver.forges.github.GithubAppForge.app_installation_id
         :parser: myst

.. py:function:: detect_github_repo(remote_url: str)
   :canonical: mass_driver.forges.github.detect_github_repo

   .. autodoc2-docstring:: mass_driver.forges.github.detect_github_repo
      :parser: myst

.. py:function:: detect_pr_info(pr_url: str) -> tuple[str, str, str]
   :canonical: mass_driver.forges.github.detect_pr_info

   .. autodoc2-docstring:: mass_driver.forges.github.detect_pr_info
      :parser: myst