Index

A

accept_preview_version() (in module octomachinery.github.api.utils) access_tokens_url (octomachinery.github.models.GitHubAppInstallation attribute) account (octomachinery.github.models.GitHubAppInstallation attribute) action (octomachinery.app.action.config.GitHubActionConfig attribute) (octomachinery.app.config.BotAppConfig attribute) ActionFailure (class in octomachinery.github.models.action_outcomes) ActionNeutral (class in octomachinery.github.models.action_outcomes) ActionSuccess (class in octomachinery.github.models.action_outcomes) actor (octomachinery.app.action.config.GitHubActionConfig attribute) aio_gather() (in module octomachinery.utils.asynctools) aio_gather_iter() (in module octomachinery.utils.asynctools) amap() (in module octomachinery.utils.asynctools)

api_client (octomachinery.github.api.app_client.GitHubApp property) (octomachinery.github.entities.action.GitHubAction property) (octomachinery.github.entities.app_installation.GitHubAppInstallation property) app (octomachinery.github.entities.app_installation.GitHubAppInstallation property) app_id (octomachinery.github.config.app.GitHubAppIntegrationConfig attribute) (octomachinery.github.models.GitHubAppInstallation attribute) app_name (octomachinery.github.config.app.GitHubAppIntegrationConfig attribute) app_slug (octomachinery.github.models.GitHubAppInstallation attribute) app_url (octomachinery.github.config.app.GitHubAppIntegrationConfig attribute) app_version (octomachinery.github.config.app.GitHubAppIntegrationConfig attribute) augment_http_headers() (in module octomachinery.github.utils.event_utils) auto_cleanup_aio_tasks() (in module octomachinery.utils.asynctools)

B

BotAppConfig (class in octomachinery.app.config)

C

ConcurrentRouter (class in octomachinery.routing.routers) ContextLookupError

convert_datetime() (in module octomachinery.github.models.utils) created_at (octomachinery.github.models.GitHubAppInstallation attribute)

D

debug (octomachinery.app.runtime.config.RuntimeConfig attribute) delete() (octomachinery.github.api.raw_client.RawGitHubAPI method) delivery_id (octomachinery.github.models.events.GitHubWebhookEvent attribute) detect_env_mode() (in module octomachinery.app.runtime.utils) dict_to_kwargs_cb() (in module octomachinery.utils.asynctools) dispatch() (octomachinery.routing.abc.OctomachineryRouterBase method) (octomachinery.routing.routers.ConcurrentRouter method) (octomachinery.routing.routers.GidgetHubRouterBase method) (octomachinery.routing.routers.NonBlockingConcurrentRouter method)

dispatch_event() (in module octomachinery.routing.default_router) (octomachinery.github.api.app_client.GitHubApp method) dispatch_via() (octomachinery.github.models.events.GitHubEvent method)

E

emit_routes_for() (octomachinery.routing.abc.OctomachineryRouterBase method) (octomachinery.routing.routers.GidgetHubRouterBase method) env (octomachinery.app.runtime.config.RuntimeConfig attribute) event (octomachinery.github.entities.action.GitHubAction property) event_name (octomachinery.app.action.config.GitHubActionConfig attribute)

event_path (octomachinery.app.action.config.GitHubActionConfig attribute) events (octomachinery.github.models.GitHubAppInstallation attribute) expired (octomachinery.github.models.GitHubInstallationAccessToken property) expires_at (octomachinery.github.models.GitHubInstallationAccessToken attribute) extract_private_key_sha1_fingerprint() (in module octomachinery.github.models.private_key)

F

fingerprint (octomachinery.github.models.private_key.GitHubPrivateKey property) from_dotenv() (octomachinery.app.config.BotAppConfig class method) from_env() (octomachinery.app.config.BotAppConfig class method) from_environ() (octomachinery.app.action.config.GitHubActionConfig class method) (octomachinery.app.config.BotAppConfig class method) (octomachinery.app.runtime.config.RuntimeConfig class method) (octomachinery.app.server.config.WebServerConfig class method) (octomachinery.github.config.app.GitHubAppIntegrationConfig class method) from_file() (octomachinery.github.models.events.GitHubEvent class method) (octomachinery.github.models.events.GitHubWebhookEvent class method) (octomachinery.github.models.private_key.GitHubPrivateKey class method)

from_fixture() (octomachinery.github.models.events.GitHubEvent class method) (octomachinery.github.models.events.GitHubWebhookEvent class method) from_fixture_fd() (octomachinery.github.models.events.GitHubEvent class method) (octomachinery.github.models.events.GitHubWebhookEvent class method) from_gidgethub() (octomachinery.github.models.events.GitHubEvent class method) (octomachinery.github.models.events.GitHubWebhookEvent class method) from_http_request() (octomachinery.github.models.events.GitHubWebhookEvent class method)

G

generate_help() (octomachinery.app.action.config.GitHubActionConfig class method) (octomachinery.app.config.BotAppConfig class method) (octomachinery.app.runtime.config.RuntimeConfig class method) (octomachinery.app.server.config.WebServerConfig class method) (octomachinery.github.config.app.GitHubAppIntegrationConfig class method) get_installation() (octomachinery.github.api.app_client.GitHubApp method) get_installation_by_id() (octomachinery.github.api.app_client.GitHubApp method) get_installation_config() (in module octomachinery.app.runtime.installation_utils) get_installations() (octomachinery.github.api.app_client.GitHubApp method) get_server_runner() (in module octomachinery.app.server.machinery) get_token() (octomachinery.github.entities.app_installation.GitHubAppInstallation method) get_version_from_scm_tag() (in module octomachinery.utils.versiontools) getitem() (octomachinery.github.api.raw_client.RawGitHubAPI method) getiter() (octomachinery.github.api.raw_client.RawGitHubAPI method) gh_jwt (octomachinery.github.api.app_client.GitHubApp property) GidgetHubRouterBase (class in octomachinery.routing.routers)

github (octomachinery.app.config.BotAppConfig attribute) GitHubAction (class in octomachinery.github.entities.action) GitHubActionConfig (class in octomachinery.app.action.config) GitHubActionError GitHubApp (class in octomachinery.github.api.app_client) GitHubAppInstallation (class in octomachinery.github.entities.app_installation) (class in octomachinery.github.models) GitHubAppIntegrationConfig (class in octomachinery.github.config.app) GitHubError GitHubEvent (class in octomachinery.github.models.events) GitHubInstallationAccessToken (class in octomachinery.github.models) GitHubJWTToken (class in octomachinery.github.api.tokens) GitHubOAuthToken (class in octomachinery.github.api.tokens) GitHubPrivateKey (class in octomachinery.github.models.private_key) GitHubToken (class in octomachinery.github.api.tokens) GitHubWebhookEvent (class in octomachinery.github.models.events)

H

has_multiple_single_files (octomachinery.github.models.GitHubAppInstallation attribute) (octomachinery.github.models.GitHubInstallationAccessToken attribute)

host (octomachinery.app.server.config.WebServerConfig attribute) html_url (octomachinery.github.models.GitHubAppInstallation attribute)

I

id (octomachinery.github.models.GitHubAppInstallation attribute)

is_initialized (octomachinery.github.api.raw_client.RawGitHubAPI property)

L

log_installs_list() (octomachinery.github.api.app_client.GitHubApp method)

log_webhook_secret_status() (in module octomachinery.app.server.machinery)

M

make_http_headers_from_event() (in module octomachinery.github.utils.event_utils) make_jwt_for() (octomachinery.github.models.private_key.GitHubPrivateKey method) mark_uninitialized_in_repr() (in module octomachinery.github.api.utils) matches_fingerprint() (octomachinery.github.models.private_key.GitHubPrivateKey method) mode (octomachinery.app.runtime.config.RuntimeConfig attribute) module octomachinery octomachinery.app octomachinery.app.action octomachinery.app.action.config octomachinery.app.action.runner octomachinery.app.config octomachinery.app.routing octomachinery.app.routing.abc octomachinery.app.routing.decorators octomachinery.app.routing.routers octomachinery.app.routing.webhooks_dispatcher octomachinery.app.runtime octomachinery.app.runtime.config octomachinery.app.runtime.context octomachinery.app.runtime.installation_utils octomachinery.app.runtime.utils octomachinery.app.server octomachinery.app.server.config octomachinery.app.server.machinery octomachinery.app.server.runner octomachinery.cli octomachinery.github octomachinery.github.api octomachinery.github.api.app_client octomachinery.github.api.raw_client octomachinery.github.api.tokens octomachinery.github.api.utils octomachinery.github.config octomachinery.github.config.app octomachinery.github.entities octomachinery.github.entities.action octomachinery.github.entities.app_installation octomachinery.github.errors octomachinery.github.models octomachinery.github.models.action_outcomes octomachinery.github.models.checks_api_requests octomachinery.github.models.events octomachinery.github.models.private_key octomachinery.github.models.utils octomachinery.github.utils octomachinery.github.utils.event_utils octomachinery.routing octomachinery.routing.abc octomachinery.routing.decorators octomachinery.routing.default_router octomachinery.routing.routers octomachinery.routing.webhooks_dispatcher octomachinery.runtime octomachinery.runtime.context octomachinery.runtime.utils octomachinery.utils octomachinery.utils.asynctools octomachinery.utils.versiontools

N

name (octomachinery.github.models.events.GitHubEvent attribute)

NewCheckRequest (class in octomachinery.github.models.checks_api_requests) NonBlockingConcurrentRouter (class in octomachinery.routing.routers)

O

octomachinery module octomachinery.app module octomachinery.app.action module octomachinery.app.action.config module octomachinery.app.action.runner module octomachinery.app.config module octomachinery.app.routing module octomachinery.app.routing.abc module octomachinery.app.routing.decorators module octomachinery.app.routing.routers module octomachinery.app.routing.webhooks_dispatcher module octomachinery.app.runtime module octomachinery.app.runtime.config module octomachinery.app.runtime.context module octomachinery.app.runtime.installation_utils module octomachinery.app.runtime.utils module octomachinery.app.server module octomachinery.app.server.config module octomachinery.app.server.machinery module octomachinery.app.server.runner module octomachinery.cli module octomachinery.github module octomachinery.github.api module octomachinery.github.api.app_client module octomachinery.github.api.raw_client module octomachinery.github.api.tokens module octomachinery.github.api.utils module

octomachinery.github.config module octomachinery.github.config.app module octomachinery.github.entities module octomachinery.github.entities.action module octomachinery.github.entities.app_installation module octomachinery.github.errors module octomachinery.github.models module octomachinery.github.models.action_outcomes module octomachinery.github.models.checks_api_requests module octomachinery.github.models.events module octomachinery.github.models.private_key module octomachinery.github.models.utils module octomachinery.github.utils module octomachinery.github.utils.event_utils module octomachinery.routing module octomachinery.routing.abc module octomachinery.routing.decorators module octomachinery.routing.default_router module octomachinery.routing.routers module octomachinery.routing.webhooks_dispatcher module octomachinery.runtime module octomachinery.runtime.context module octomachinery.runtime.utils module octomachinery.utils module octomachinery.utils.asynctools module octomachinery.utils.versiontools module OctomachineryRouterBase (class in octomachinery.routing.abc)

P

parse_event_stub_from_fd() (in module octomachinery.github.utils.event_utils) patch() (octomachinery.github.api.raw_client.RawGitHubAPI method) payload (octomachinery.github.models.events.GitHubEvent attribute) permissions (octomachinery.github.models.GitHubAppInstallation attribute) (octomachinery.github.models.GitHubInstallationAccessToken attribute) port (octomachinery.app.server.config.WebServerConfig attribute) post() (octomachinery.github.api.raw_client.RawGitHubAPI method)

private_key (octomachinery.github.config.app.GitHubAppIntegrationConfig attribute) private_key_fingerprint (octomachinery.github.config.app.GitHubAppIntegrationConfig attribute) process_event() (in module octomachinery.routing.default_router) process_event_actions() (in module octomachinery.routing.default_router) process_github_action() (in module octomachinery.app.action.runner) process_webhook_payload() (in module octomachinery.routing.decorators) put() (octomachinery.github.api.raw_client.RawGitHubAPI method)

R

RawGitHubAPI (class in octomachinery.github.api.raw_client) read_file_contents_from_repo() (in module octomachinery.app.runtime.installation_utils) ref (octomachinery.app.action.config.GitHubActionConfig attribute) repositories (octomachinery.github.models.GitHubInstallationAccessToken attribute) repositories_url (octomachinery.github.models.GitHubAppInstallation attribute) repository (octomachinery.app.action.config.GitHubActionConfig attribute) repository_selection (octomachinery.github.models.GitHubAppInstallation attribute) (octomachinery.github.models.GitHubInstallationAccessToken attribute) return_code (octomachinery.github.models.action_outcomes.ActionFailure attribute) (octomachinery.github.models.action_outcomes.ActionNeutral attribute) (octomachinery.github.models.action_outcomes.ActionSuccess attribute)

route_github_event() (in module octomachinery.routing.webhooks_dispatcher) route_github_webhook_event() (in module octomachinery.app.routing.webhooks_dispatcher) run() (in module octomachinery.app.action.runner) (in module octomachinery.app.server.runner) run_forever() (in module octomachinery.app.server.machinery) runtime (octomachinery.app.config.BotAppConfig attribute) RuntimeConfig (class in octomachinery.app.runtime.config)

S

SecretStr (class in octomachinery.github.models.utils) server (octomachinery.app.config.BotAppConfig attribute) setup_server_runner() (in module octomachinery.app.server.machinery) sha (octomachinery.app.action.config.GitHubActionConfig attribute) single_file (octomachinery.github.models.GitHubInstallationAccessToken attribute) single_file_name (octomachinery.github.models.GitHubAppInstallation attribute)

single_file_paths (octomachinery.github.models.GitHubAppInstallation attribute) (octomachinery.github.models.GitHubInstallationAccessToken attribute) start_tcp_site() (in module octomachinery.app.server.machinery) SuperSecretStr (class in octomachinery.github.models.utils) suspended_at (octomachinery.github.models.GitHubAppInstallation attribute) suspended_by (octomachinery.github.models.GitHubAppInstallation attribute)

T

target_id (octomachinery.github.models.GitHubAppInstallation attribute) target_type (octomachinery.github.models.GitHubAppInstallation attribute) terminate_action() (octomachinery.github.errors.GitHubActionError method) to_gh_query() (in module octomachinery.github.models.checks_api_requests) to_gidgethub() (octomachinery.github.models.events.GitHubEvent method) (octomachinery.github.models.events.GitHubWebhookEvent method)

token (octomachinery.app.action.config.GitHubActionConfig attribute) (octomachinery.github.entities.action.GitHubAction property) (octomachinery.github.models.GitHubInstallationAccessToken attribute) try_await() (in module octomachinery.utils.asynctools)

U

UpdateCheckRequest (class in octomachinery.github.models.checks_api_requests)

updated_at (octomachinery.github.models.GitHubAppInstallation attribute) user_agent (octomachinery.github.config.app.GitHubAppIntegrationConfig property)

V

validate_fingerprint_if_present() (in module octomachinery.github.config.app)

validate_http_headers() (in module octomachinery.github.utils.event_utils) validate_is_not_none_if_app() (in module octomachinery.github.config.app)

W

WEBHOOK_EVENTS_ROUTER (in module octomachinery.routing.default_router) webhook_secret (octomachinery.github.config.app.GitHubAppIntegrationConfig attribute)

WebServerConfig (class in octomachinery.app.server.config) workflow (octomachinery.app.action.config.GitHubActionConfig attribute) workspace (octomachinery.app.action.config.GitHubActionConfig attribute)