configuration.py: easy and flexible configuration management for python applications
Configuration.py is a library for configuration management in python apps. Its goal is to make configurations management
as human-friendly as possible. It provides a simple load
function that allows to load configuration for given environment
from any supported formats.
Configuration.py can be used to organize configs for any python applications. Taste better with dotenv.
Installation
$ pip install configuration.py
Usage
By default library trying to find application
config file in config
folder relatively to application working directory.
Config could be in any supported formats: application.yaml, application.json
etc.
load
function will return config from environment section set by ENV
or ENVIRONMENT
system environment variable.
Create application.yaml
in config
folder with the content:
production:
debug: False
development:
debug: True
Set current environment into system variable:
$ export ENV=development
Usage:
>>> from configuration_py import load
>>> config_dict = load()
>>> print(config_dict)
{'environment': 'development', 'debug': True}
You can also be more specific, which config should be loaded and from where:
from configuration_py import load
config_dict = load('database', folder='./config/db')
You can set environment directly on load:
from configuration_py import load
config_dict = load(environment='test')
Config could be generated using supported template language. From the box you can use python string templates. System environment variables will be passed to the template automatically.
So you can create application.yaml.tmpl
, which means yaml config will be generated using python string templates,
and you can use system environment variables inside a config.
application.yaml.tmpl
production:
log_file: $LOG_FILE
development:
log_file: None
$ export LOG_FILE=/var/log/logfile.log
>>> from configuration_py import load
>>> config_dict = load(environment='production')
>>> print(config_dict)
{'environment': 'production', 'log_file': '/var/log/logfile.log'}
>>> config_dict = load(environment='development')
>>> print(config_dict)
{'environment': 'development', 'log_file': 'None'}
Supported formats
- YAML by extensions
.yaml
,.yml
- JSON by extensions
.json
- Python string templates by
.tmpl
and.strtmpl
Examples
Django
Database config config/database.yaml.tmpl
:
production:
databases:
default:
ENGINE: 'django.db.backends.postgresql'
NAME: 'mydatabase'
USER: $DATABASE_USER
PASSWORD: $DATABASE_PASSWORD
HOST: '127.0.0.1'
PORT: $DATABASE_PORT
development:
databases:
default:
ENGINE: 'django.db.backends.postgresql'
NAME: 'mydatabase'
USER: 'user'
PASSWORD: ''
HOST: '127.0.0.1'
PORT: '5432'
test:
databases:
default:
ENGINE: 'django.db.backends.sqlite3'
NAME: ':memory:'
In settings.py
:
from configuration_py import load
...
DATABASES = load('database')['databases']
Middleware config:
Loading config in code:
from configuration_py import load
...
MIDDLEWARE_CLASSES = reduce(lambda x, item: x+item[1], sorted(load()['middleware'].items()), [])
This will add extra middleware on development:
default: &default
1:
- django.middleware.security.SecurityMiddleware
- django.contrib.sessions.middleware.SessionMiddleware
- django.middleware.common.CommonMiddleware
production:
middleware:
<<: *default
development:
middleware:
<<: *default
2:
- python.path.to.LoginRequiredMiddleware
Split middlewares to insert additional middleware:
default: &default
1:
- django.middleware.security.SecurityMiddleware
- django.contrib.sessions.middleware.SessionMiddleware
- django.middleware.common.CommonMiddleware
3:
- django.middleware.csrf.CsrfViewMiddleware
- django.contrib.auth.middleware.AuthenticationMiddleware
production:
middleware:
<<: *default
development:
middleware: &development
<<: *default
2:
- python.path.to.LoginRequiredMiddleware
test:
middleware:
<<: *development
4:
- python.path.to.LastMiddleware
Middleware list will be loaded from configuration and merged in a right order:
>>> reduce(lambda x, item: x+item[1], sorted(load(environment="production")['middleware'].items()), [])
['django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware']
>>>
>>> reduce(lambda x, item: x+item[1], sorted(load(environment="development")['middleware'].items()), [])
['django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'python.path.to.LoginRequiredMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware']
>>>
>>> reduce(lambda x, item: x+item[1], sorted(load(environment="test")['middleware'].items()), [])
['django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'python.path.to.LoginRequiredMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'python.path.to.LastMiddleware']
SQLAlchemy
Configuration loading:
database.yaml.tmpl
production:
database:
url: $DATABASE_URL
development:
database:
url: 'sqlite:///local.db'
test:
database:
url: 'sqlite://'
>>> from configuration_py import load
>>> from sqlalchemy import create_engine
>>> db_config = load(configuration='database')
>>> engine = create_engine(db_config['database']['url'])
>>> from configuration_py import load
>>> from sqlalchemy import engine_from_config
>>> db_config = load(configuration='database')
>>> engine = engine_from_config(**db_config['database'])
Contributing
Want to contribute? Great!
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Make the appropriate changes in the files. Don't forget about tests!
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Testing
Project has two kind of tests: unit tests and acceptance tests. To run unit tests project uses nose (with optional coverage) and for acceptance tests - behave and sure. To run tests install all of this tools and use appropriate CLI:
nosetests --with-coverage --cover-package=configuration_py
behave ./configuration_py/tests/acceptance/
License
MIT © Bogdan Frankovskyi