didactic-settings

Typed application settings on top of dx.Model.

PyPI Python License CI Docs

Contributes didactic.settings to the namespace package.

Install

pip install didactic-settings
pip install 'didactic-settings[yaml]'   # adds YAML support

The package depends on didactic. The optional yaml extra adds PyYAML for .yaml / .yml config files.

Quickstart

import didactic.api as dx
from didactic.settings import Settings, EnvSource, FileSource


class AppSettings(Settings):
    debug: bool = False
    db_url: str
    port: int = 8080

    __sources__ = (
        FileSource(path="config.toml"),
        EnvSource(prefix="APP_"),
    )


cfg = AppSettings.load()
cfg.port                      # the resolved value
cfg.__provenance__["port"]    # 'env' / 'file' / 'default' / 'override'

Settings inherits from dx.Model, so every Model feature works: type checks, axioms, validators, JSON Schema export.

Sources

source reads from
EnvSource(prefix="APP_") environment variables
DotEnvSource(path=".env", prefix="APP_") dotenv file
FileSource(path="config.toml") JSON, TOML, or YAML by suffix
CliSource(args=ns) parsed argparse.Namespace or dict

Sources are walked in declaration order; later sources override earlier ones. Keyword overrides at Settings.load(...) win over every source.

Documentation

See Guides > Settings for the full source documentation, coercion rules, and provenance reporting.

License

Released under the MIT License.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for aaronstevenwhite from gravatar.com aaronstevenwhite

Credits

Author: Aaron Steven White

License expression

MIT
View SPDX License List

Requires

Python >=3.14

Provides Extra

toml yaml

Tags

configuration didactic panproto settings

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

didactic_settings-0.10.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

didactic_settings-0.10.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file didactic_settings-0.10.0.tar.gz.

File metadata

  • Download URL: didactic_settings-0.10.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for didactic_settings-0.10.0.tar.gz
Algorithm Hash digest
SHA256 10d248f7e0b55d71d87b122178fb56cdb97afb7af7fc3c6443a6420a20d0b7c6
MD5 b9b1a0415ae1b6d0e0498eaa59e639a4
BLAKE2b-256 6b3500a1294d32005405ea1cc5c768fa91a4dd95db46f506521abbd2f4b13388

See more details on using hashes here.

Provenance

The following attestation bundles were made for didactic_settings-0.10.0.tar.gz:

Publisher: release.yml on panproto/didactic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file didactic_settings-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for didactic_settings-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 024dde773aa317d1357f25d2ee595d9ddf256684ee04ef2c1e86fc4aa7a04a6a
MD5 836a1510032afdca55db70a996fcf244
BLAKE2b-256 d8c5d87a8d9cdf1df486aa485d7e271016607d310e572857872772d54c2f4073

See more details on using hashes here.

Provenance

The following attestation bundles were made for didactic_settings-0.10.0-py3-none-any.whl:

Publisher: release.yml on panproto/didactic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.10.0 This release

2 files

0.9.1

2 files

0.9.0

2 files

0.8.0

2 files

0.7.8

2 files

0.7.7

2 files

0.7.6

2 files

0.7.5

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page