ALERT!!! This is the outdated version of docs

Go to dynaconf.com for the new version docs.

dynaconf a layered configuration system for Python applications - with strong support for 12-factor applications and extensions for Flask and Django.

Release v2.2.3. (Installation)

Dynaconf - Easy and Powerful Settings Configuration for Python

• Strict separation of settings from code (following 12-factor applications Guide).
• Define comprehensive default values.
• Store parameters in multiple file formats (.toml, .json, .yaml, .ini and .py).
• Sensitive secrets like tokens and passwords can be stored in safe places like .secrets file or vault server.
• Parameters can optionally be stored in external services like Redis server.
• Simple feature flag system.
• Layered [environment] system.
• Environment variables can be used to override parameters.
• Support for .env files to automate the export of environment variables.
• Correct data types (even for environment variables).
• Have only one canonical settings module to rule all your instances.
• Drop in extension for Flask app.config object.
• Drop in extension for Django conf.settings object.
• Powerful $ dynaconf CLI to help you manage your settings via console.
• Customizable Validation System to ensure correct config parameters.
• Allow the change of dynamic parameters on the fly without the need to redeploy your application.

Who is using Dynaconf?

• Pulp Project - Django - (RedHat)
• Ansible Galaxy - Django - (RedHat)
• Insights QE (RedHat)
• CloudForms QE (RedHat)
• Seek AI & Catho Job boards - Flask - (on AI APIs)
• Quokka CMS - Flask
• iNNOVO Cloud GmbH
• Teraki
• ARA Records Ansible - Django

Are you using Dynaconf? Please give feedback

Contents:

• Getting Started
  • Installation
  • Usage
  • Working environments
  • The settings files
  • Settings files location
  • Loading order
  • Local configuration files and merging to existing data
  • Settings File Formats
  • Supported file formats
  • Additional secrets file (for CI, jenkins etc.)
  • Including files inside files
  • Programmatically loading a settings file
  • Template substitutions
  • Merging existing data structures
  • More examples
• Sensitive secrets
  • Using .secrets files
  • Using Vault server
  • Additional secrets file (for CI, jenkins etc.)
• Environment variables
  • overloading parameters via env vars
  • .env files
  • Precedence and type casting
  • Merging new data to existing variables
• Accessing parameters
  • As attributes (dot notation)
  • As dictionary [item]
  • Default values (get)
  • Forcing type casting
  • Boxed values
  • Export settings as a Python dictionary
• The dynaconf CLI
  • dynaconf –help
  • dynaconf init
  • dynaconf list
  • dynaconf write
  • dynaconf validate
  • dynaconf –version
  • dynaconf –docs
  • dynaconf –banner
• External storages
  • Using REDIS
  • Using Hashicorp Vault to store secrets
  • Custom Storages
• Configuring Dynaconf
  • Configuration options
  • Internal use variables
  • Deprecated options
• Advanced Usage
  • Customizing the settings object
  • Module impersonation
  • Switching working environments
  • Populating objects
  • Customizations
  • Exporting
  • Preloading files
• Feature flag system
  • feature toggles
• Validation
  • Validating in Python programatically
  • CLI and dynaconf_validators.toml
• Flask Extension
  • Initialize the extension
  • Use FLASK_ environment variables
  • Settings files
  • Customizations
  • Loading Flask Extensions Dynamically
• Django Extension
  • Initialize the extension
  • Using DJANGO_ environment variables
  • Settings files
  • Customizations
  • Reading Settings on Standalone Scripts
  • Testing on Django
  • Explicit mode
  • Knowm Caveats
  • Deprecation note
• Testing
  • Pytest
  • Mocking
• Extending
  • Creating new loaders
• How to contribute
• Examples
  • Supported file formats
  • Using a default main config file plus variable settings file
  • More examples
• Credits
• Alternatives
• Module reference
  • dynaconf package

Indices and tables

• Index
• Module Index
• Search Page