Metadata-Version: 2.1
Name: confuse
Version: 1.0.0
Summary: painless YAML configuration
Home-page: https://github.com/beetbox/confuse
Author: Adrian Sampson
Author-email: adrian@radbox.org
License: MIT
Description: Confuse: painless YAML config files
        ===================================
        
        .. image:: https://travis-ci.org/beetbox/confuse.svg?branch=master
            :target: https://travis-ci.org/beetbox/confuse
        
        .. 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,
        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
           Mac OS X; ``%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.
        
        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/
        .. _MIT license: http://www.opensource.org/licenses/mit-license.php
        .. _beets: https://github.com/beetbox/beets
        
Platform: ALL
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
