The dynamic configurator for your Python Project
Project description
dynaconf - Configuration Management for Python.
Features
- Inspired by the 12-factor application guide
- Settings management (default values, validation, parsing, templating)
- Protection of sensitive information (passwords/tokens)
- Multiple file formats
toml|yaml|json|ini|pyand 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
$ pip install dynaconf
Initialize Dynaconf on project root directory
$ 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|pyondynaconf init -f <fileformat>toml is the default and also the most recommended format for configuration.
Dynaconf init creates the following files
.
├── 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
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
initcommand as shown above and you can give any name you want instead of the defaultconfig.py(the file must be in your importable python path) - See more options that you can pass toDynaconfclass initializer on https://dynaconf.com
Using Dynaconf
Put your settings on settings.{toml|yaml|ini|json|py}
username = "admin"
port = 5555
database = {name='mydb', schema='main'}
Put sensitive information on .secrets.{toml|yaml|ini|json|py}
password = "secret123"
IMPORTANT:
dynaconf initcommand puts the.secrets.*in your.gitignoreto avoid it to be exposed on public repos but it is your responsibility to keep it safe in your local environment, also the recommendation for production environments is to use the built-in support for Hashicorp Vault service for password and tokens.
Optionally you can now use environment variables to override values per execution or per environment.
# override `port` from settings.toml file and automatically casts as `int` value.
export DYNACONF_PORT=9900
On your code import the settings object
from path.to.project.config import settings
# Reading the settings
settings.username == "admin" # dot notation with multi nesting support
settings.PORT == 9900 # case insensitive
settings['password'] == "secret123" # dict like access
settings.get("nonexisting", "default value") # Default values just like a dict
settings.databases.name == "mydb" # Nested key traversing
settings['databases.schema'] == "main" # Nested key traversing
More
- Settings Schema Validation
- Custom Settings Loaders
- Vault Services
- Template substitutions
- etc...
There is a lot more you can do, read the docs: http://dynaconf.com
Contribute
Main discussions happens on Discussions Tab learn more about how to get involved on CONTRIBUTING.md guide
More
If you are looking for something similar to Dynaconf to use in your Rust projects: https://github.com/rubik/hydroconf
And a special thanks to Caneco for the logo.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file dynaconf-3.1.11.tar.gz.
File metadata
- Download URL: dynaconf-3.1.11.tar.gz
- Upload date:
- Size: 207.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d9cfb50fd4a71a543fd23845d4f585b620b6ff6d9d3cc1825c614f7b2097cb39 |
|
| MD5 | 2d39182e79166bc495263be82e699e29 |
|
| BLAKE2b-256 | 546f09c3ca2943314e0cae5cb2eeca1b77f5968855e13d6fdaae32c8e055eb7c |
File details
Details for the file dynaconf-3.1.11-py2.py3-none-any.whl.
File metadata
- Download URL: dynaconf-3.1.11-py2.py3-none-any.whl
- Upload date:
- Size: 211.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 87e0b3b12b5db9e8fb465e1f8c7fdb926cd2ec5b6d88aa7f821f316df93fb165 |
|
| MD5 | 9c50e0c113858138e51806556a68cffe |
|
| BLAKE2b-256 | e7670600b5fbd27928c112a11a5018b3e9ebf3d7f896d510c3c231f8d09886ae |
