docs/development/ENGINEERING_FOUNDATION.md

Engineering Foundation

Status

Milestone 1 is implemented locally pending lockfile generation and verification. It contains no provider integration, database, live/paper account, external network request, or trading loop.

Components

Module	Responsibility
drift_quant.config	Validates non-secret environment selection and log level.
drift_quant.secrets	Loads required secrets at an integration boundary and redacts its string representations.
drift_quant.logging	Emits structured JSON and recursively redacts sensitive context keys.
drift_quant.domain	Defines immutable lifecycle, strategy version, signal, order intent, and risk-decision contracts.

Configuration

Copy .env.example to a local ignored .env only if a local environment loader is added later. Environment values shown there are non-secret. Future provider code must obtain required credentials through drift_quant.secrets.load_required_secret; its validation errors and rendered values are redacted.

Verification commands

uv sync --all-groups --locked
uv run ruff check .
uv run ruff format --check .
uv run pytest

The commands are not evidence of success until their output has been observed. External-provider tests will be opt-in and are not part of this foundation.