octomachinery.app.config module

GitHub App/bot configuration.

class octomachinery.app.config.BotAppConfig(github=Raise(), action=Raise(), server=Raise(), runtime=Raise())

Bases: object

Bot app config.

Construct it as follows:: >>> from octomachinery.app.config import BotAppConfig >>> config = BotAppConfig.from_dotenv() # for dev env >>> config = BotAppConfig.from_env() # for pure env >>>

action

classmethod from_dotenv(*, app_name: Optional[str] = None, app_version: Optional[str] = None, app_url: Optional[str] = None)

Return an initialized dev config instance.

Read .env into env vars before that.

classmethod from_env(*, app_name: Optional[str] = None, app_version: Optional[str] = None, app_url: Optional[str] = None)

Return an initialized config instance.

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-25423447-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/latest', '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': '09b5e5ca2f7eb1f7d7b6f974392456a25411a11a', '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)

github

runtime

server