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)[source]#
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/', 'HOSTNAME': 'build-22446379-project-386025-octomachinery', 'READTHEDOCS_GIT_CLONE_URL': 'https://github.com/sanitizers/octomachinery.git', 'HOME': '/home/docs', 'NO_COLOR': '1', 'READTHEDOCS': 'True', 'READTHEDOCS_PROJECT': 'octomachinery', 'READTHEDOCS_OUTPUT': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/_readthedocs/', 'PATH': '/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', 'READTHEDOCS_VERSION_TYPE': 'branch', 'LANG': 'C.UTF-8', 'READTHEDOCS_LANGUAGE': 'en', 'DEBIAN_FRONTEND': 'noninteractive', 'READTHEDOCS_GIT_COMMIT_HASH': 'b36c3d3d49da813ac46e361424132955a4e99ac8', 'READTHEDOCS_VERSION_NAME': 'latest', 'READTHEDOCS_VERSION': 'latest', 'PWD': '/home/docs/checkouts/readthedocs.org/user_builds/octomachinery/checkouts/latest/docs', 'READTHEDOCS_GIT_IDENTIFIER': 'master', '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#
The User-Agent value to use when hitting GitHub API.
- webhook_secret#
- octomachinery.github.config.app.validate_fingerprint_if_present(instance, _attribute, value)[source]#
Validate that the private key matches the fingerprint pin.
- Raises:
ValueError – if the fingerprint pin is present but doesn’t match the private key