Skip to main content

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

Project description

Gitlab Pipeline Status Gitlab Code Coverage 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

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.

  • Full typing support and experimental mypy plugin added in 1.5.0 .

  • Support for Python 3.9, 3.10, 3.11 and 3.12 was added in version 1.5.0 .

  • Support for Python 2.7, 3.5, 3.6 and 3.7 was dropped in version 1.5.0 .

  • Support for Vault backend was dropped in version 1.5.0 .

  • Support for Python 3.4 was dropped in version 1.4.0 .

  • Support for Jython was dropped in version 1.4.0 .

  • Support for Python 3.8 was added in version 1.3.1 .

  • Support for Python 3.3 was dropped in version 1.3.0 .

License

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

Contributing

To contribute, base your changes on the develop branch. Use init.sh to install the required Python version using pyenv and setup a virtualenv in vendor/. Activate the virtualenv using source vendor/bin/activate. After the initial setup, use init.sh at any time to bring your environment up-to-date with the latest requirements.

$ ./init.sh
Installing Python version 3.x.x using pyenv
Creating Python venv named 'vendor'
- Install uv
- Updating pip, setuptools
Resolved 2 packages in 2ms
Installed 1 package in 10ms
...
- Installing dev and docs dependencies
Installed 56 packages in 32ms
...
- Installing app in edit mode
...
Installed 1 package in 0ms
...
- Installing pre-commit hook
pre-commit installed at .git/hooks/pre-commit

Make sure your contribution doesn’t break any existing tests, and add relevant new tests. You can run the test suite using tox:

$ tox

To check for style issues, just run the test suite, ruff is automatically called for linting and formatting checks.

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

Project details


Download files

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

Source Distribution

omniconf-1.5.1.tar.gz (45.1 kB view details)

Uploaded Source

Built Distribution

omniconf-1.5.1-py3-none-any.whl (50.1 kB view details)

Uploaded Python 3

File details

Details for the file omniconf-1.5.1.tar.gz.

File metadata

  • Download URL: omniconf-1.5.1.tar.gz
  • Upload date:
  • Size: 45.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for omniconf-1.5.1.tar.gz
Algorithm Hash digest
SHA256 abaa6f4d058a05d8329608232dfbdbd08b03c39fbaffcb4b4b7c107eb5bb7cfe
MD5 8d839d2a5e3a0df62ab117b5aa2d67c6
BLAKE2b-256 a426a41fdabcdec796dd7f877087284367d265be248f3607a215219ad88e8a2b

See more details on using hashes here.

Provenance

File details

Details for the file omniconf-1.5.1-py3-none-any.whl.

File metadata

  • Download URL: omniconf-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 50.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for omniconf-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cb8ef747a81a4a6be4e7ee79ae0df25abc85baed6d7c229bfb122a54a4b1f52d
MD5 cc4b5556c0be63e3ea7050e10a2ea668
BLAKE2b-256 9e7551b79f767ef43a01a43b0c2f3d09eae5793758000b5c9125d6a876ee2bda

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page