Configuration API reference

groundworkers.config

AppConfig dataclass

Resolved runtime configuration owned and consumed by Groundworkers.

Groundworkers is the only application in the stack rather than a library, so unlike its siblings it resolves the whole picture once and hands the same object to the tool registry, both transports, --describe, and the setup console. Each optional backend is resolved to None when unconfigured, so availability is decided in one place instead of at every call site.

Settings are read through groundworkers: this type deliberately does not re-export them, so each one has exactly one name.

describe()

Return an operator-safe description without credentials or raw URLs.

GroundworkersConfig

Bases: PackageConfigBase

Package-level configuration owned by Groundworkers.

The shared configure path (omop-config configure groundworkers, and the --set flags it generates) addresses one field at a time. Related settings are grouped by name prefix.

Every field carries a description, which provides the CLI flag help, the interactive prompt text, and the generated documentation.

Notes

By design, this config is for internal use only and must not be imported or resolved by any other package.