Skip to main content

A Python library that makes configuring your application independent from your configuration backend.

Project description

Travis build status Coveralls License PyPI version Supported Python versions Supported Python implementations

A Python library that makes configuring your application independent from your configuration backend.


Read the complete documentation on Read the Docs.

Why omniconf?

Configuring applications is hard, and it doesn’t help that there are many different (and valid) ways to do it:

  • cli arguments
  • config files: ConfigObj (.ini like), JSON, YAML
  • environment variables
  • key/value stores: etcd, consul, vault

Each of this methods are a valid way to configure an application, and each have their own strengths. Cli arguments are most suited for tools and daemons. Configuration files are suited for applications that have more complex requirements. Environment variables and key/value stores are handy when using containers. You may even want to use a combination of methods (not yet implemented).

This library aims to make configuring the application easier, and allows you to use multiple configuration backends transparently.

For up-to-date examples, take a look here.


omniconf is licensed under LGPLv3. See the LICENSE file for details.


To contribute, base your changes on the develop branch. Make sure your contribution doesn’t break any existing tests, and add relevant new tests.

You can run the test suite using tox, which by default will run tests for all supported Python versions. You probably want to run just a few of them at a time, use the -e switch for that:

$ tox -e py27
$ tox -e py34

To check for style issues, run flake8:

$ tox -e flake8

When you’re done, open a pull request on Github.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
omniconf-1.2.1-py2.py3-none-any.whl (45.6 kB) Copy SHA256 hash SHA256 Wheel 3.4
omniconf-1.2.1.tar.gz (36.6 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page