README

django-loader

django-loader: a configuration variable and secrets loader for Django apps.

PyPI Version Documentation Status

What is django-loader?

django-loader is a configuration variable and secrets loader for Django apps. It loads a dictionary of configuration variables into settings.py that consists of default values, values from a secrets file (defaults to .env), and from environment variables. It can load configuration files in TOML, JSON, YAML, and BespON formats and dump in any format, including as environment variables (Bourne shell).

Installation

Install django-loader with:

pip install django-loader
pip freeze > requirements.txt

or add as a poetry dependency.

Usage

Console:

usage: loader.py [-h] [--show-warranty] [--show-license] [-p PREFIX]
                 [-d {TOML,JSON,YAML,BespON,ENV}] [-V] [-g]
                 [file]

This program comes with ABSOLUTELY NO WARRANTY; for details type ``loader.py
--show-warranty``. This is free software, and you are welcome to redistribute
it under certain conditions; type ``loader.py --show-license`` for details.

positional arguments:
  file                  Secrets file to be loaded; default is `.env`.

options:
  -h, --help            show this help message and exit
  --show-warranty       Show warranty information.
  --show-license        Show license information.
  -p PREFIX, --prefix PREFIX
                        Environment variable prefix.
  -d {TOML,JSON,YAML,BespON,ENV}, --dump-format {TOML,JSON,YAML,BespON,ENV}
                        Configuration dump format.
  -V, --validate-secrets
                        Validate the secrets only.
  -g, --generate-secret-key
                        Generate a secret key.

In Python:

>>> import loader
>>> secrets = loader.load_secrets(**{"SECRET_KEY": ""})
>>> SECRET_KEY = secrets["SECRET_KEY"]

See the source and documentation for more information.

Author

Jeremy A Gray