Confuse is a configuration library for Python that uses
YAML_. It takes
care of defaults, overrides, type checking, command-line integration,
human-readable errors, and standard OS-specific locations.
Here’s what Confuse brings to the table:
An utterly sensible API resembling dictionary-and-list structures
but providing transparent validation without lots of boilerplate
config['num_goats'].get(int) to get the configured
number of goats and ensure that it’s an integer.
Combine configuration data from multiple sources. Using
layering, Confuse allows user-specific configuration to seamlessly
override system-wide configuration, which in turn overrides built-in
defaults. An in-package
config_default.yaml can be used to
provide bottom-layer defaults using the same syntax that users will
see. A runtime overlay allows the program to programmatically
override and add configuration values.
Look for configuration files in platform-specific paths. Like
~/.config on Unix; "Application Support" on
%APPDATA% on Windows. Your program gets its own
directory, which you can use to store additional data. You can
transparently create this directory on demand if, for example, you
need to initialize the configuration file on first run. And an
environment variable can be used to override the directory's
Integration with command-line arguments via
from the standard library. Use argparse's declarative API to allow
command-line options to override configured defaults.
Confuse is available on
PyPI <https://pypi.org/project/confuse/>_ and can be installed
.. code-block:: sh
pip install confuse
Confuse's documentation_ describes its API in detail.
Confuse was made to power
Like beets, it is available under the
.. _ConfigParser: http://docs.python.org/library/configparser.html .. _YAML: http://yaml.org/ .. _optparse: http://docs.python.org/dev/library/optparse.html .. _argparse: http://docs.python.org/dev/library/argparse.html .. _logging: http://docs.python.org/library/logging.html .. _Confuse's documentation: http://confuse.readthedocs.org/en/latest/usage.html .. _MIT license: http://www.opensource.org/licenses/mit-license.php .. _beets: https://github.com/beetbox/beets