Skip to main content

kaava

Load typed Python configuration from YAML, TOML, or JSON into dataclasses, with validation, source tracing, environment-variable overlays, and a diagnostic CLI.

Requires Python 3.11 or later. YAML support uses ruamel.yaml (default) or PyYAML; TOML and JSON use the standard library.

Install

pip install kaava

Quickstart

Define your configuration shape as a plain dataclass and call load().

import dataclasses
from kaava import conf_field, load


@dataclasses.dataclass
class DBConfig:
    host: str = conf_field(description='database host')
    port: int = conf_field(default=5432)


@dataclasses.dataclass
class AppConfig:
    name: str = conf_field(description='application name')
    db: DBConfig = conf_field(description='database connection')
    debug: bool = conf_field(default=False)


cfg = load(AppConfig, 'config.yaml')
print(cfg.name, cfg.db.host, cfg.db.port)

config.yaml:

name: myapp
db:
  host: localhost

Fields with no default or default_factory are required. Nested dataclasses map to YAML mappings and are built recursively. load() raises on the first error encountered; use validate() or load_valid() to collect all errors.

For a quick feature-by-feature tour, see quickstart. For a step-by-step tutorial that builds a real command-line tool from scratch, see tutorial.

Learn more

kaava's man pages are installable locally with kaava eject man (see man kaava) or browsable under docs/man/:

  • man kaava -- the CLI: doctor, explain, validate, eject config, eject man, complete, version; options, exit codes, examples.
  • man 3 kaava -- the full library API: every exported function and type (load, doctor, explain, conf_field, the overlay builders, the error hierarchy), exact signatures and behavior.
  • man 5 kaava -- file formats: the CLI's own settings (~/.config/kaava/cli.yaml), the auto-discovery locations load() falls back to, and the dotenv format.
  • man 7 kaava -- the sources-then-overlays loading model end to end, a worked "adopting kaava in a new project" walkthrough, and how the CLI configures itself using the same load() any caller uses.

Companion CLI

The kaava command exposes the library's diagnostic functions as subcommands, against a dotted import path (module.path:ClassName):

kaava doctor          myapp.config:AppConfig config.yaml
kaava explain         myapp.config:AppConfig config.yaml
kaava validate        myapp.config:AppConfig config.yaml
kaava eject config    myapp.config:AppConfig

A remembered default target (see man 5 kaava) lets every command above drop the dataclass path and sources entirely: kaava doctor alone. Every command, subcommand, and long option accepts an unambiguous prefix (kaava ver for kaava version); calling kaava or kaava eject alone prints that command's own help and exits 0.

Design and requirements

Software Requirements Specification : KAA-SRS-001 -- requirements/

Software Design Description : KAA-SDD-001 -- design/

Both documents follow the MIL-STD-498 DID structure and are rendered into the documentation site alongside the tutorial and quickstart.

Changes

See releases/ for the release history, or releases/changes/ for the full detail behind each summary.

Complexity

The code base complexity is documented at complexity/.

Coverage

The test suite maintains 100% branch coverage. The HTML report (if generated) is in site/coverage/.

SBOM

Runtime dependency information is published in docs/sbom/ in SPDX 3.0 (JSON-LD) and CycloneDX 1.6 (JSON) formats. See docs/sbom/README.md for the component inventory and validation guide.

Metadata

Release files for kaava 2026.11.1

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

Source distribution (sdist)

Source distribution for kaava 2026.11.1
File Size Uploaded Provenance Actions
kaava-2026.11.1.tar.gz 80.2 kB Without provenance Details for kaava-2026.11.1.tar.gz

Built distribution (wheel)

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

Total release size: 132.1 kB

Release files / kaava-2026.11.1.tar.gz

Download URL kaava-2026.11.1.tar.gz
Size 80.2 kB
Tags Source
SHA-256 checksum
How to use checksums
6a54e7aeb2ddfa8bb06367ef3e575b1e9231f7ed7c01b03659180129aa16fb47
BLAKE2b-256 checksum
How to use checksums
85b7bb90d49a8903feba9d062ef318bd61d81fb98a3a5a7dfeaa76edb304bf84
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.5

Release files / kaava-2026.11.1-py3-none-any.whl

Download URL kaava-2026.11.1-py3-none-any.whl
Size 51.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
13d7e7b541f2c61e7650321d0750b0a1f186fd73b56ec92fc30ef39f7617984b
BLAKE2b-256 checksum
How to use checksums
141924670b292f408de43fa12d9b0c6f396be8cb77b0b81a6ec50f7fd99c154f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.5

Security for kaava 2026.11.1

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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.

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