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.

Documentation

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, TOML
  • 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.

Changes

For an up-to-date changelog, see ChangeLog.

Support for Python 3.3 was dropped in version 1.3.0 . Support for Python 3.8 was added in version 1.3.1 . Support for Python 3.4 was dropped in version 1.4.0 . Support for Jython was dropped in version 1.4.0 .

License

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

Contributing

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 py37

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.

Files for omniconf, version 1.4.0
Filename, size File type Python version Upload date Hashes
Filename, size omniconf-1.4.0-py2.py3-none-any.whl (50.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size omniconf-1.4.0.tar.gz (39.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page