octomachinery.github.config.app module

Config schema for a GitHub App instance details.

class octomachinery.github.config.app.GitHubAppIntegrationConfig(app_id=None, private_key=None, private_key_fingerprint=None, webhook_secret=None, app_name=None, app_version=None, app_url=None)

Bases: object

GitHub App auth related config.

app_id

app_name

app_url

app_version

classmethod from_environ(environ=environ({'READTHEDOCS_VIRTUALENV_PATH': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/envs/stable', 'READTHEDOCS_CANONICAL_URL': 'https://docs.octomachinery.dev/en/stable/', 'HOSTNAME': 'build-25422547-project-386025-octomachinery', 'READTHEDOCS_GIT_CLONE_URL': 'https://github.com/sanitizers/octomachinery.git', 'HOME': '/home/docs', 'NO_COLOR': '1', 'READTHEDOCS': 'True', 'READTHEDOCS_PRODUCTION_DOMAIN': 'readthedocs.org', 'READTHEDOCS_REPOSITORY_PATH': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/stable', 'READTHEDOCS_PROJECT': 'octomachinery', 'READTHEDOCS_OUTPUT': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/stable/_readthedocs/', 'PATH': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/envs/stable/bin:/home/docs/.asdf/shims:/home/docs/.asdf/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', 'READTHEDOCS_VERSION_TYPE': 'tag', 'LANG': 'C.UTF-8', 'READTHEDOCS_LANGUAGE': 'en', 'DEBIAN_FRONTEND': 'noninteractive', 'READTHEDOCS_GIT_COMMIT_HASH': '42b3ee43c3f8beaeb185ddeef64fc91621e28360', 'READTHEDOCS_VERSION_NAME': 'stable', 'READTHEDOCS_VERSION': 'stable', 'PWD': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/stable/docs', 'READTHEDOCS_GIT_IDENTIFIER': '42b3ee43c3f8beaeb185ddeef64fc91621e28360', 'DOCUTILSCONFIG': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/stable/docs/docutils.conf'}))

classmethod generate_help(**kwargs)

private_key

private_key_fingerprint

property user_agent

The User-Agent value to use when hitting GitHub API.

webhook_secret

octomachinery.github.config.app.validate_fingerprint_if_present(instance, _attribute, value)

Validate that the private key matches the fingerprint pin.

Raises:

ValueError – if the fingerprint pin is present but doesn’t match the private key

octomachinery.github.config.app.validate_is_not_none_if_app(self, attr, value)

Forbid None value in a GitHub App context.