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/latest', 'READTHEDOCS_CANONICAL_URL': 'https://docs.octomachinery.dev/en/latest/', 'READTHEDOCS_GIT_CLONE_URL': 'https://github.com/sanitizers/octomachinery.git', 'HOME': '/home/docs', 'NO_COLOR': '1', 'READTHEDOCS': 'True', 'READTHEDOCS_PRODUCTION_DOMAIN': 'app.readthedocs.org', 'READTHEDOCS_REPOSITORY_PATH': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest', 'READTHEDOCS_PROJECT': 'octomachinery', 'READTHEDOCS_OUTPUT': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/_readthedocs/', 'READTHEDOCS_VERSION_TYPE': 'branch', 'LANG': 'C.UTF-8', 'READTHEDOCS_LANGUAGE': 'en', 'READTHEDOCS_GIT_COMMIT_HASH': 'c69244151c23ef9228db745559763658c207ccc3', 'READTHEDOCS_VERSION_NAME': 'latest', 'READTHEDOCS_VERSION': 'latest', 'READTHEDOCS_GIT_IDENTIFIER': 'master', 'PATH': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/.tox/build-docs/bin:/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/envs/latest/bin:/home/docs/.asdf/shims:/home/docs/.asdf/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', 'PYTHONHASHSEED': '1596472266', 'PIP_DISABLE_PIP_VERSION_CHECK': '1', 'PYTHONIOENCODING': 'utf-8', 'TOX_ENV_NAME': 'build-docs', 'TOX_WORK_DIR': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/.tox', 'TOX_ENV_DIR': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/.tox/build-docs', 'VIRTUAL_ENV': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/.tox/build-docs', 'PIP_USER': '0', 'DOCUTILSCONFIG': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/docs/docutils.conf'}))

classmethod generate_help(**kwargs)

private_key

private_key_fingerprint

property user_agent: str

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

webhook_secret

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

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) → None

Forbid None value in a GitHub App context.