Description

<!-- [](http://dynaconf.com) --> <p align="center"><img src="/art/header.png?v2" alt="dynaconf. new logo"></p> > **dynaconf** - Configuration Management for Python. [](/LICENSE) [](https://pypi.python.org/pypi/dynaconf) []()  [](https://github.com/dynaconf/dynaconf/actions/workflows/main.yml) [](https://codecov.io/gh/dynaconf/dynaconf) [](https://www.codacy.com/gh/dynaconf/dynaconf/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=dynaconf/dynaconf&amp;utm_campaign=Badge_Grade)     [](https://github.com/ambv/black/)  [](https://github.com/dynaconf/dynaconf/discussions) [](https://gitter.im/dynaconf/dev?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://matrix.to/#/#dynaconf:matrix.org) ## Features - Inspired by the [12-factor application guide](https://12factor.net/config) - Settings management (default values, validation, parsing, templating) - Protection of sensitive information (passwords/tokens) - Multiple file formats `toml|yaml|json|ini|py` and also customizable loaders. - Full support for environment variables to override existing settings (dotenv support included). - Optional layered system for multi environments `[default, development, testing, production]` - Built-in support for Hashicorp Vault and Redis as settings and secrets storage. - Built-in extensions for **Django** and **Flask** web frameworks. - CLI for common operations such as `init, list, write, validate, export`. - full docs on https://dynaconf.com ### Install ```bash $ pip install dynaconf ``` #### Initialize Dynaconf on project root directory ```plain $ cd path/to/your/project/ $ dynaconf init -f toml ⚙️ Configuring your Dynaconf environment ------------------------------------------ 🐍 The file `config.py` was generated. 🎛️ settings.toml created to hold your settings. 🔑 .secrets.toml created to hold your secrets. 🙈 the .secrets.* is also included in `.gitignore` beware to not push your secrets to a public repo. 🎉 Dynaconf is configured! read more on https://dynaconf.com ``` > **TIP:** You can select `toml|yaml|json|ini|py` on `dynaconf init -f <fileformat>` **toml** is the default and also the most recommended format for configuration. #### Dynaconf init creates the following files ```plain . ├── config.py # This is from where you import your settings object (required) ├── .secrets.toml # This is to hold sensitive data like passwords and tokens (optional) └── settings.toml # This is to hold your application settings (optional) ``` On the file `config.py` Dynaconf init generates the following boilerpate ```py from dynaconf import Dynaconf settings = Dynaconf( envvar_prefix="DYNACONF", # export envvars with `export DYNACONF_FOO=bar`. settings_files=['settings.yaml', '.secrets.yaml'], # Load files in the given order. ) ``` > **TIP:** You can create the files yourself instead of using the `init` command as shown above and you can give any name you want instead of the default `config.py` (the file must be in your importable python path) - See more options that you can pass to `Dynaconf` class initializer on https://dynaconf.com #### Using Dynaconf Put your settings on `settings.{toml|yaml|ini|json|py}` ```toml username = "admin" port = 5555 database = {name='mydb', schema='main'} ``` Put sensitive information on `.secrets.{toml|yaml|ini|json|py}` ```toml password = "secret123" ``` > **IMPORTANT:** `dynaconf init` command puts the `.secrets.*` in your `.gitignore` to avoid it to be exposed on public repos but it is your responsibility to keep it safe in your local environment, also the recommendat