https://github.com/beetbox/confuse

painless YAML config files for Python
https://github.com/beetbox/confuse

configuration python yaml

Last synced: 5 days ago
JSON representation

painless YAML config files for Python

• Host: GitHub
• URL: https://github.com/beetbox/confuse
• Owner: beetbox
• License: mit
• Created: 2012-02-02T03:16:05.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2023-12-02T18:58:07.000Z (about 1 year ago)
• Last Synced: 2024-10-29T15:22:18.789Z (3 months ago)
• Topics: configuration, python, yaml
• Language: Python
• Homepage: https://pypi.org/project/confuse/
• Size: 480 KB
• Stars: 417
• Watchers: 16
• Forks: 51
• Open Issues: 49
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Confuse: painless YAML config files

===================================

.. image:: https://github.com/beetbox/confuse/workflows/Build/badge.svg?branch=master

    :target: https://github.com/beetbox/confuse/actions

.. image:: http://img.shields.io/pypi/v/confuse.svg

    :target: https://pypi.python.org/pypi/confuse

**Confuse** is a configuration library for Python that uses `YAML`_. It takes

care of defaults, overrides, type checking, command-line integration,

environment variable support, human-readable errors, and standard OS-specific

locations.

What It Does

------------

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

   code. Type ``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

   ``$XDG_CONFIG_HOME`` or ``~/.config`` on Unix; "Application Support" on

   macOS; ``%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

   location.

-  Integration with **command-line arguments** via `argparse`_ or `optparse`_

   from the standard library. Use argparse's declarative API to allow

   command-line options to override configured defaults.

-  Include configuration values from **environment variables**. Values undergo

   automatic type conversion, and nested dicts and lists are supported.

Installation

------------

Confuse is available on `PyPI `_ and can be installed

using :code:`pip`:

.. code-block:: sh

    pip install confuse

Using Confuse

-------------

`Confuse's documentation`_ describes its API in detail.

Credits

-------

Confuse was made to power `beets`_.

Like beets, it is available under the `MIT license`_.

.. _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