Metadata-Version: 1.1
Name: ezcf
Version: 0.0.1.post1
Summary: Import JSON/YAML like importing .py files
Home-page: http://github.com/laike9m/ezcf/
Author: laike9m
Author-email: laike9m@gmail.com
License: MIT
Description: ezcf
        ====
        
        |Build Status| |Supported Python versions| |Latest Version| |Development
        Status|
        
        ezcf stands for **easy configuration**, it allows you to import
        JSON/YAML like importing .py files, which is very useful for reading
        conf files with these formats.
        
        OK, stop talking, show us some code!
        
        On the left is what you'll normally do, on the right is the ezcf way.
        Much more elegant isn't it?
        
        Install
        -------
        
        ::
        
            pip install ezcf
        
        If you run into ``error: yaml.h: No such file or directory``, don't
        worry, you can still use ezcf without any problem.
        
        Sample Usage
        ------------
        
        ezcf supports all kinds of valid import statements, here's an example:
        
        ::
        
            ├── subdir
            │   ├── __init__.py
            │   └── sample_yaml.yaml
            ├── test_normal.py
            └── sample_json.json
        
        Various ways to use configurations in ``sample_yaml.yaml`` and
        ``sample_json.json``:
        
        .. code:: python
        
            import ezcf
        
            from subdir.sample_yaml import *
            # or
            from subdir.sample_yaml import something
            # or
            import subdir.sample_yaml as sy
            print(sy.something)
        
            from sample_json import *
            # or
            from sample_json import something
            # or
            import sample_json as sj
            print(sj.something)
        
        You can assume they're just regular python files.(Currently ezcf only
        supports files with utf-8 encoding)
        
        What about relative import? Yes, ezcf supports relative import, as long
        as you use it *correctly*. See
        `tests2 <https://github.com/laike9m/ezcf/tree/master/tests2>`__ for an
        example.
        
        Something to note before using ezcf:
        
        1. ezcf is still in developement. If you find any bug, please report it
           in issues;
        2. Be careful importing YAML which contains multiple documents: if there
           exists keys with the same name, only one of them will be loaded;
        3. Namespace package is not supported yet, pull requests are welcome.
        
        Roadmap
        -------
        
        -  [x] Use dot to seperate folder/subfolder/file
        -  [x] Unicode support
        -  [x] JSON support
        -  [x] YAML support
        -  [ ] INI support
        -  [ ] Auto encoding detect?
        -  [x] CI
        -  [ ] coverage
        -  [x] pypi
        
        License
        -------
        
        MIT
        
        .. |Build Status| image:: https://travis-ci.org/laike9m/ezcf.svg
           :target: https://travis-ci.org/laike9m/ezcf
        .. |Supported Python versions| image:: https://pypip.in/py_versions/ezcf/badge.svg
           :target: https://pypi.python.org/pypi/ezcf/
        .. |Latest Version| image:: https://pypip.in/version/ezcf/badge.svg
           :target: https://pypi.python.org/pypi/ezcf/
        .. |Development Status| image:: https://pypip.in/status/ezcf/badge.svg
           :target: https://pypi.python.org/pypi/ezcf/
        
Keywords: config,import
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Python Modules
