Skip to main content

Hierarchical YAML config reader that reads from multiple files and an environment variable

Project description


A library that makes it easy to load YAML config files in a hierarchical manner. Also loads YAML content from CONFIG environment variable.


from magnet import Config

config = Config().read_all('path/to/custom/config/file')
# will result in KeyError if value is missing
value = config['key.subkey.subsubkey']

By default, this library will load the config files in order:

  1. ./config/default.yml - can be committed to the repository
  2. ./config/local.yml - should not be committed to allow custom config for devs
  3. A custom config YAML file
  4. YAML from the CONFIG environment variable

All of these files are optional, but the key lookups will result with KeyError if a key is missing.


make ci            - Run the CI pipeline (deps, lint, test-coverage)
make lint          - Lint all project files
make test          - Run all tests
make test-watch    - Run all tests and re-run on file changes
make test-coverage - Run all tests and calculate test coverage
make deps          - Create a virtual environment and install dependencies
make freeze        - Freeze the requirements
make env           - Create a virtual environment

Project details

Download files

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

Files for magnet, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size magnet-1.0.1-py3-none-any.whl (3.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size magnet-1.0.1.tar.gz (3.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page