ConfigIt 0.1.3
Python Configurations
License: MIT
Keywords: configuration

ConfigIt
========

.. image:: https://secure.travis-ci.org/pictage/ConfigIt.png?branch=develop

ConfigIt is MIT Licensed Python Configuration library brought to you
by the camera shy people at `Pictage <http://www.pictage.com>`_.

Python is all about the dicts so why do we settle for `INIs <http://en.wikipedia.org/wiki/INI_file>`_?


Features
--------

All configuration files are native python files.

Using ConfigIt you can read those files in as a module, or file
and return a dictionary with attribute access.

One of the most powerful things about configit is its ability to use other
configurations within a configuration.


Installation
------------

To install configit, simply: ::

    $ pip install configit


API Documentation
-----------------

configit.from_file(filepath)
    Reads a string file path and returns a ConfigDict. 

::

    filepath = r'tests/configs/default.py'

    config = from_file(filepath)
    assert config.config_dict.name == 'default'



configit.from_module(module)
    Reads an imported module and returns a ConfigDict.

::

    import tests.configs.module_config

    config = configit.from_module(tests.configs.module_config)
    assert config.config_dict.name == 'module_config'


configit.from_dict(conf_dict)
    Reads a dictionary and returns a ConfigDict.

    ConfigDicts are accessible by attributes as well as keys.

::

    config = dict(answer=42)

    config = configit.from_dict(config)
    assert config.answer == 42


configit.use(conf_source)
    Within a python configuration you can import another python configuration.
    The imported configuration will update local name space of the importing configuration.
    This means values in sub configuration will be accessible in the local configuration.

    This can be useful for boiler plate configurations where you only need a few items changed.

        **file_supplement.py** contents: ::

            answer=42

        **file.py** contents: ::

            import configit
            configit.use('file_supplement.py')

        **Code** using configit to get the configuration: ::

            import configit
            config = configit.from_file('file.py')

            assert config.answer == 42

    **Order matters!**

        **file_supplement.py** contents: ::

            answer=42

        **file.py** contents: ::

            import configit
            configit.use('file_supplement.py')
            answer=5

        **Code** using configit to get the configuration: ::

            import configit
            config = configit.from_file('file.py')

            assert config.answer == 5


**For further examples refer to included tests.**


Contribute
----------

#. Fork `the repository <https://github.com/pictage/ConfigIt>`_ on Github to start making your changes to the **develop** branch (or branch off of it).
#. Install to your env or venv by running: ::

    $ python setup.py develop

#. Hack-a-thon, dance party!
#. Write a test which shows that the bug was fixed or that the feature works as expected.
#. Test by running: ::

    $ python setup.py test

#. Send a pull request and bug the maintainer until it gets merged and published. :) Make sure to add yourself to `AUTHORS <https://github.com/pictage/ConfigIt/blob/master/AUTHORS.rst>`_.