Reference

The reference section provides factual, lookup-oriented documentation for Protean's machinery. Use it to find specific configuration options, field types, CLI commands, adapter settings, and API details.

For understanding why things work as they do, see Concepts. For step-by-step how-to instructions, see Guides.

Domain Elements

Decorator options, meta attributes, reflection API, identity configuration.

Element Decorators · Object Model · Identity
Fields

All field types, arguments, and definition styles.

Fields
Configuration

domain.toml parameters, environment overlays, adapter configuration.

Configuration
Logging

[logging] config schema, CLI flags, framework logger catalog, wide event field schemas, redaction, trace-context fields.

Logging
CLI

All protean CLI commands and their options.

CLI Commands
Server

Subscription types, profiles, multi-worker mode, observability.

Subscription Types · Configuration · Multi-Worker · Observability
Adapters

Database, broker, cache, and event store adapter configuration.

Adapters
Type Checking

Mypy plugin setup and configuration.

Type Checking
Testing

Pytest plugin, --protean-env option, and test fixtures.

Pytest Plugin
Migration

Version migration guides.

Migration guides
Python API Reference

Auto-generated class signatures, method parameters, and return types from source code.

API Reference
Applicability Charter

What Protean is a good fit for, and the shapes of systems it is not, with the reason in each case.

Applicability Charter
Guarantees

Per-port, per-adapter ordering, delivery, consistency, and isolation. This is the contract the conformance tests check against.

Guarantees
Versioning Policy

What a version number promises, and how to enforce it in your own CI.

Versioning Policy
Stable Surface

Which names the compatibility contract covers: Stable, Provisional, or Internal.

Stable Surface