Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dynaconf/dynaconf
Configuration Management for Python ⚙
https://github.com/dynaconf/dynaconf
12factorapp app-config config configuration configuration-management django django-configuration django-extension dynaconf environment-configuration environment-variables fastapi flask flask-configuration flask-extension hacktoberfest python settings vault yaml
Last synced: 4 days ago
JSON representation
Configuration Management for Python ⚙
- Host: GitHub
- URL: https://github.com/dynaconf/dynaconf
- Owner: dynaconf
- License: mit
- Created: 2015-08-14T21:25:22.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T11:33:43.000Z (about 2 months ago)
- Last Synced: 2024-10-30T01:03:18.526Z (about 1 month ago)
- Topics: 12factorapp, app-config, config, configuration, configuration-management, django, django-configuration, django-extension, dynaconf, environment-configuration, environment-variables, fastapi, flask, flask-configuration, flask-extension, hacktoberfest, python, settings, vault, yaml
- Language: Python
- Homepage: https://dynaconf.com
- Size: 8.06 MB
- Stars: 3,768
- Watchers: 35
- Forks: 291
- Open Issues: 127
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- best-of-python - GitHub - 23% open · ⏱️ 28.05.2024): (Configuration)
- awesome-repositories - dynaconf/dynaconf - Configuration Management for Python ⚙ (Python)
- awesome-list - dynaconf - Configuration Management for Python. (Desktop App Development / Python Toolkit)
- awesome-fastapi - :octocat: dynaconf :star: 2.7k+ :fork_and_knife: 200+ - Configuration Management for Python gear. (Configuration)
- jimsghstars - dynaconf/dynaconf - Configuration Management for Python ⚙ (Python)
README
> **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&utm_medium=referral&utm_content=dynaconf/dynaconf&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 ` **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 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.
```bash
# override `port` from settings.toml file and automatically casts as `int` value.
export DYNACONF_PORT=9900
```
On your code import the `settings` object
```py
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](https://github.com/dynaconf/dynaconf/discussions) learn more about how to get involved on [CONTRIBUTING.md guide](CONTRIBUTING.md)
## 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](https://twitter.com/caneco) for the logo.