Skip to main content

Described configuration for large, complex projects

Project description

Build Status Coverage Status Documentation Status PyPI Version PyPI License

Described configuration for large, complex projects. Read the docs!

Features

  • Define config keys using a nicer API to colander.

  • Get config values as a callable before loading or directly afterwards.

  • Define multiple ‘confers’ to allow large codebases to be worked on independently.

Quick Usage

Firstly, define the key(s) you want to be in the config file. They can be any type colander supports, even custom types. Builtin types can be accessed more easily through the included data module.

import confing
from confing import data

confer = confing.getConfer('my_confer_name')
confer.define(data.String(name='secret_key'))

Next, load the data for the configuration.

loaded = confer.load({'secret_key': '...'})
loaded is confer.loaded

Lastly, get the key you want out of the config.

confer.loaded.secret_key
# or
confer.loaded['secret_key']

If you need to pass a configuration value to something either at module-import time or before the config is loaded, you can pass it a callable that will be the correct value once the config is loaded later. This will only work if the receiving party doesn’t attempt to resolve the value before the config is loaded.

``python confer.as_callable(‘secret_key’) ```

Install for development

$ pip install --editable .

Contributing

Anyone can help make this project better - read CONTRIBUTION to get started!

License

Apache 2.0. See the LICENSE file for more details.

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

confing-0.1.4.tar.gz (12.1 kB view hashes)

Uploaded Source

Built Distribution

confing-0.1.4-py2.py3-none-any.whl (6.3 kB view hashes)

Uploaded Python 2 Python 3

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