auth.py

"""This is the module that contains functions related to authenticating to GitHub with a personal access token."""

from github import Auth, Github


def auth_to_github(
    token: str,
    gh_app_id: int | None,
    gh_app_installation_id: int | None,
    gh_app_private_key_bytes: bytes,
    ghe: str | None,
    gh_app_enterprise_only: bool,
) -> Github:
    """
    Connect to GitHub.com or GitHub Enterprise, depending on env variables.

    Args:
        token (str): the GitHub personal access token
        gh_app_id (int | None): the GitHub App ID
        gh_app_installation_id (int | None): the GitHub App Installation ID
        gh_app_private_key_bytes (bytes): the GitHub App Private Key
        ghe (str | None): the GitHub Enterprise URL, or None
        gh_app_enterprise_only (bool): Set this to true if the GH APP is created on GHE and needs to communicate with GHE api only

    Returns:
        Github: the GitHub connection object
    """
    if gh_app_id and gh_app_private_key_bytes and gh_app_installation_id:
        app_auth = Auth.AppAuth(int(gh_app_id), gh_app_private_key_bytes.decode())
        installation_auth = app_auth.get_installation_auth(int(gh_app_installation_id))
        if ghe and gh_app_enterprise_only:
            github_connection = Github(base_url=f"{ghe}/api/v3", auth=installation_auth)
        else:
            github_connection = Github(auth=installation_auth)
    elif ghe and token:
        github_connection = Github(base_url=f"{ghe}/api/v3", auth=Auth.Token(token))
    elif token:
        github_connection = Github(auth=Auth.Token(token))
    else:
        raise ValueError(
            "GH_TOKEN or the set of [GH_APP_ID, GH_APP_INSTALLATION_ID, GH_APP_PRIVATE_KEY] environment variables are not set"
        )

    return github_connection