Skip to main content
dature

PyPI Supported Python versions Documentation License
CI CodeQL Dependency Review Coverage
Monthly downloads Commits since latest release Last commit date Last release date

Documentation | Changelog

Type-safe configuration loader for Python dataclasses. Load config from YAML, JSON, TOML, INI, ENV files, environment variables, Docker secrets, CLI arguments, HashiCorp Vault, Consul, etcd, Apache ZooKeeper, AWS SSM, AWS Secrets Manager, Azure App Configuration, Azure Key Vault, and GCP Secret Manager — with automatic type conversion, validation, and human-readable error messages.

Installation

pip install dature

With optional format support:

pip install dature[yaml]       # YAML (ruamel.yaml)
pip install dature[json5]      # JSON5
pip install dature[toml]       # TOML (toml_rs)
pip install dature[vault]      # HashiCorp Vault (hvac)
pip install dature[consul]     # Consul (py-consul)
pip install dature[etcd]       # etcd (etcd3gw)
pip install dature[zookeeper]  # Apache ZooKeeper (kazoo)
pip install dature[aws]        # AWS SSM & Secrets Manager (boto3)
pip install dature[azure-appconfig] # Azure App Configuration
pip install dature[azure-keyvault]  # Azure Key Vault
pip install dature[gcp]        # GCP Secret Manager
pip install dature[watch]      # File watching for background reload (watchdog)
pip install dature[secure]     # Secret detection heuristics
pip install dature[type-stubs] # Type stubs for the integrations above (mypy/pyright users)

Quick Start

from dataclasses import dataclass

import dature


@dataclass
class Config:
    host: str
    port: int
    debug: bool = False


config = dature.load(dature.Yaml12Source(file="config.yaml"), schema=Config)

Readable errors

Validation errors point at the source file, the line, and the exact value:

from dataclasses import dataclass
from typing import Literal

import dature


@dataclass
class Config:
    password: str
    host: Literal["production", "staging"]


dature.load(
    dature.Yaml12Source(file="config.yaml"),
    schema=Config,
    masking_mode="secrets_only",  # default is "all"
)
host: "development"
password: "my_secret_password"
  | dature.errors.exceptions.DatureConfigError: Config loading errors (1)
  +-+---------------- 1 ----------------
    | dature.errors.exceptions.FieldLoadError:   [host]  Invalid variant: 'development'
    |    ├── host: "development"
    |    │          ^^^^^^^^^^^
    |    └── FILE 'config.yaml', line 1
    +------------------------------------

The same format works for YAML, JSON, JSON5, TOML, INI, ENV files, environment variables, and Docker secrets. Values are masked by default (masking_mode="all"); the example uses "secrets_only" so that only password is hidden. See Masking.

Merging sources

Sources are merged in order, with a strategy for conflicts and per-field rules for lists:

from dataclasses import dataclass

import dature


@dataclass
class Config:
    tags: list[str]


config = dature.load(
    dature.Yaml12Source(file="base.yaml"),  # tags: [web, default]
    dature.Yaml12Source(file="override.yaml"),  # tags: [web, api]
    schema=Config,
    field_merges={dature.F[Config].tags: "append"},
)

print(config.tags)  # ['web', 'default', 'web', 'api']

Debug report

Pass debug=True to see which source provided each value:

import dature

config = dature.load(
    dature.Yaml12Source(file="defaults.yaml"),
    dature.Yaml12Source(file="overrides.yaml"),
    schema=Config,
    debug=True,
)

report = dature.load_report(config)
for origin in report.field_origins:
    source = Path(origin.source_file).name if origin.source_file else origin.source_loader_type
    print(f"{origin.key} = {origin.value!r} <- {source}")
host = 'production.example.com' <- overrides.yaml
port = 3000 <- defaults.yaml
tags = ['default'] <- defaults.yaml

Key Features

  • Multiple sources — YAML, JSON, JSON5, TOML, INI, ENV, environment variables, Docker secrets, CLI args (argparse or your own), HashiCorp Vault, Consul, etcd, Apache ZooKeeper, AWS SSM, AWS Secrets Manager, Azure App Configuration, Azure Key Vault, GCP Secret Manager
  • Merging — combine multiple sources with configurable strategies ("last_wins", "first_wins", "first_found", "raise_on_conflict") and per-field rules ("append", "prepend", "append_unique", custom callables)
  • Validation — Annotated field validators, root validators, __post_init__ support
  • Naming — automatic field name mapping (snake_case ↔ camelCase ↔ UPPER_SNAKE etc.)
  • Secret masking — automatic masking in error messages and logs by field type, name, or heuristic
  • ENV expansion — $VAR, ${VAR:-default} substitution in all file formats
  • Special types — SecretStr, ByteSize, PaymentCardNumber, URL, Base64UrlStr
  • Debug report — debug=True shows which source provided each field value
  • Decorator mode — @dature.load(meta) auto-loads config on dataclass instantiation with caching
  • Shared reads — Source(shared_read=...) shares one raw file read / remote fetch across multiple prefix=-bound schemas
  • CLI — dature validate and dature inspect console commands for CI and debugging
  • Cross-source refs & conditional sources — reference values across sources, activate sources based on environment
  • Extensible — plug in custom sources, type loaders, and remote backends via SourceProtocol

See the documentation for detailed guides and API reference.

Why dature?

  • Your config stays a plain dataclass. No BaseSettings base class, no vendor lock-in, no Pydantic-specific validators for custom types. Full IDE completion and mypy support come from your own class.
  • Errors you can act on. The failure names the source, the line, and the value — not a ValidationError with a model path.
  • Merge is explicit. Four source strategies plus per-field rules (append, prepend, append_unique, field groups), instead of a fixed priority order you have to work around.
  • One schema, many backends. The same dataclass loads from files, environment, CLI, Docker secrets, and remote stores (Vault, Consul, etcd, ZooKeeper, AWS, Azure, GCP) — switch sources without touching the schema.

How dature compares in detail:

When the other side wins: if Pydantic is already your core dependency, you build on FastAPI/SQLModel, or you want a CLI generated from your settings model with subcommands and async entrypoints — pydantic-settings is the natural fit. For ML experiment sweeps and config composition use Hydra. dature is aimed at application and service config: a fixed schema, several sources, and readable failures.

Requirements

  • Python >= 3.12
  • adaptix >= 3.0.0b11

Development

git clone https://github.com/reagento/dature.git
cd dature
uv sync --all-extras --all-groups

Run tests:

uv run pytest tests/ -v

Lint and type check:

uv run prek run --all-files

Build docs locally:

uv run mkdocs serve

Changelog

Each PR must include a towncrier fragment in the changes/ directory:

# Format: changes/<issue-or-pr-number>.<type>
echo "Added support for YAML anchors." > changes/42.feature

Available <type> values:

Type Description
feature New features
bugfix Bug fixes
doc Documentation improvements
removal Deprecations and removals
misc Other changes

Use +<description> instead of an issue number for changes without a linked issue:

echo "Fixed typo in error message." > changes/+fix-typo.bugfix.md

Releasing

  1. Run the Release workflow and choose bump type (patch / minor / major). The next version is calculated from the latest git tag automatically.
  2. The workflow builds the changelog from fragments and creates a PR.
  3. Merge the PR — CI automatically creates the tag, publishes to PyPI, creates a GitHub Release, and updates docs.

License

Apache License 2.0

Metadata

Release files for dature 1.6.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dature 1.6.3
File Size Uploaded Provenance
dature-1.6.3.tar.gz 658.9 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for dature 1.6.3
File Interpreter ABI Platform
dature-1.6.3-py3-none-any.whl Python 3 none any Details

Total release size: 886.8 kB

Release files / dature-1.6.3.tar.gz

Download URL dature-1.6.3.tar.gz
Size 658.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7bc5d0c37ac14127dca646cfc449f3bdfedb6a147c057a81019bd9f838902930
BLAKE2b-256 checksum
How to use checksums
3546faa8441953fb8b40f15050817e538146c9978932c056bf1c8f456c45975a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

Release files / dature-1.6.3-py3-none-any.whl

Download URL dature-1.6.3-py3-none-any.whl
Size 227.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a193cc86df0b9075af77bc55417ad12001d602ad6ca2f09e09e0d7dd80673443
BLAKE2b-256 checksum
How to use checksums
7cf6fa79c91115f61071001252b18876748994875a440ded59f45fbbd83fa821
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

Security for dature 1.6.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for dature-1.6.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.6.3 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page