Metadata-Version: 1.1
Name: rcfile
Version: 0.1.1
Summary: Configuration file loader
Home-page: https://github.com/aequitas/rcfile
Author: Johan Bloemberg
Author-email: mail@ijohan.nl
License: Copyright 2013 Johan Bloemberg

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Description: ===============================
        rcfile
        ===============================
        
        .. image:: https://badge.fury.io/py/rcfile.png
            :target: http://badge.fury.io/py/rcfile
        
        .. image:: https://travis-ci.org/aequitas/rcfile.png?branch=master
                :target: https://travis-ci.org/aequitas/rcfile
        
        .. image:: https://pypip.in/d/rcfile/badge.png
                :target: https://crate.io/packages/rcfile?version=latest
        
        
        Configuration file loader for Python projects
        
        Based on: https://github.com/dominictarr/rc
        
        Features
        --------
        
        Read environment variables and config files and return them merged with predefined list of arguments.
        
        Arguments:
            appname - application name, used for config files and environemnt variable names.
            args - arguments from command line (optparse, docopt, etc).
            strip_dashes - strip dashes prefixing key names from args dict.
        
        Returns:
            dict containing the merged variables of environment variables, config files and args.
        
        Environment variables are read if they start with appname in uppercase with underscore, for example:
        
            TEST_VAR=1
        
        Config files compatible with ConfigParser are read and the section name appname is read, example:
        
            [appname]
            var=1
        
        Files are read from: /etc/appname/config, /etc/appfilerc, ~/.config/appname/config, ~/.config/appname,
            ~/.appname/config, ~/.appnamerc, .appnamerc, file provided by config variable in args.
        
        Example usage with docopt:
        
            args = rcfile(__name__, docopt(__doc__, version=__version__))
        
        * TODO
        
        Requirements
        ------------
        
        - Python >= 2.6 or >= 3.3
        
        License
        -------
        
        MIT licensed. See the bundled `LICENSE <https://github.com/aequitas/rcfile/blob/master/LICENSE>`_ file for more details.
Keywords: rcfile
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
