Skip to content

Credentials

credentials

GhAuthDependency

Bases: AuthDependencySpec

GitHub CLI authentication dependency with catalog metadata.

Source code in packages/axm-git/src/axm_git/credentials.py
Python
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class GhAuthDependency(AuthDependencySpec):  # type: ignore[explicit-any]
    """GitHub CLI authentication dependency with catalog metadata."""

    package: str
    status_command: str
    login_command: str

    def __init__(
        self,
        *,
        name: str,
        source: object,
        package: str,
        status_command: str,
        login_command: str,
    ) -> None:
        super().__init__(
            name=name,
            source=source,
            package=package,
            status_command=status_command,
            login_command=login_command,
        )

gh_credentials()

Declare the GitHub CLI session consumed by axm-git.

Source code in packages/axm-git/src/axm_git/credentials.py
Python
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def gh_credentials() -> list[CredentialGroup]:
    """Declare the GitHub CLI session consumed by axm-git."""
    dependency = GhAuthDependency(
        name="gh",
        source=_GhAuthSource(),
        package="axm-git",
        status_command="gh auth status",
        login_command="gh auth login",
    )
    group = CredentialGroup(
        id="gh",
        package="axm-git",
        title="GitHub CLI",
        specs=(),
        auth_dependencies=(dependency,),
    )
    return [group]