octomachinery.github.models package

Submodules

• octomachinery.github.models.action_outcomes module
  • ActionFailure
    • ActionFailure.return_code
  • ActionNeutral
    • ActionNeutral.return_code
  • ActionSuccess
    • ActionSuccess.return_code
• octomachinery.github.models.checks_api_requests module
  • NewCheckRequest
  • UpdateCheckRequest
  • to_gh_query()
• octomachinery.github.models.events module
  • GitHubEvent
    • GitHubEvent.dispatch_via()
    • GitHubEvent.from_file()
    • GitHubEvent.from_fixture()
    • GitHubEvent.from_fixture_fd()
    • GitHubEvent.from_gidgethub()
    • GitHubEvent.name
    • GitHubEvent.payload
    • GitHubEvent.to_gidgethub()
  • GitHubWebhookEvent
    • GitHubWebhookEvent.delivery_id
    • GitHubWebhookEvent.from_file()
    • GitHubWebhookEvent.from_fixture()
    • GitHubWebhookEvent.from_fixture_fd()
    • GitHubWebhookEvent.from_gidgethub()
    • GitHubWebhookEvent.from_http_request()
    • GitHubWebhookEvent.to_gidgethub()
• octomachinery.github.models.private_key module
  • GitHubPrivateKey
    • GitHubPrivateKey.fingerprint
    • GitHubPrivateKey.from_file()
    • GitHubPrivateKey.make_jwt_for()
    • GitHubPrivateKey.matches_fingerprint()
  • extract_private_key_sha1_fingerprint()
• octomachinery.github.models.utils module
  • SecretStr
  • SuperSecretStr
  • convert_datetime()

Module contents

Models representing objects in GitHub API.

class octomachinery.github.models.GitHubAppInstallation(id, app_id, app_slug, created_at, updated_at, account: Dict[str, Any], events: List[str], permissions: Dict[str, Any], repository_selection, single_file_name: str | None, target_id, target_type: str, access_tokens_url, html_url, repositories_url, suspended_at: str | None, suspended_by: str | None, has_multiple_single_files: bool | None, single_file_paths: List[str])

Bases: object

Represents a GitHub App installed into a user or an organization profile.

It has its own ID for installation which is a unique combo of an app and a profile (user or org).

access_tokens_url: str

API endpoint to retrieve access token from.

account: Dict[str, Any]

Target account (org or user) where this GitHub App is installed into.

app_id: int

GitHub App ID.

app_slug: str

GitHub App slug.

created_at: datetime

Date time when the installation has been installed.

events: List[str]

List of webhook events the app will be receiving from the account.

has_multiple_single_files: bool | None

html_url: str

URL for controlling the GitHub App Installation.

id: int

Installation ID.

permissions: Dict[str, Any]

Permission levels of access to API endpoints types.

repositories_url: str

API endpoint listing repositories accessible by this Installation.

repository_selection: str

Repository selection mode.

single_file_name: str | None

File path the GitHub app controls.

single_file_paths: List[str]

suspended_at: str | None

suspended_by: str | None

target_id: int

Target account ID where this GitHub App is installed into.

target_type: str

Target account type where this GitHub App is installed into.

updated_at: datetime

Date time when the installation was last updated.

class octomachinery.github.models.GitHubInstallationAccessToken(token, expires_at, permissions: Dict[str, str], repository_selection, repositories=[], single_file: str | None = None, has_multiple_single_files: bool | None = False, single_file_paths: List[str] = None)

Bases: object

Struct for installation access token response from GitHub API.

property expired: bool

Check whether this token has expired already.

expires_at: datetime

Token expiration time.

has_multiple_single_files: bool | None

permissions: Dict[str, str]

Permission levels of access to API endpoints types.

repositories: List[Dict[str, Any]]

List of accessible repositories.

repository_selection: str

Repository selection mode.

single_file: str | None

File path the GitHub app controls.

single_file_paths: List[str]

token: SecretStr

Access token for GitHub App Installation.