Import JSON/YAML like importing .py files
Project description
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.
Supported File Types
Currently ezcf supports JSON, YAML and INI with extension json, yaml, yml, ini.
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:
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.
Something to note before using ezcf:
ezcf is still in developement. If you find any bug, please report it in issues;
Be careful importing YAML which contains multiple documents: if there exists keys with the same name, only one of them will be loaded. So it’s better not to use multiple documents;
All values in .ini files are kept as it is and loaded as a string;
Namespace package is not supported yet, pull requests are welcome.
Run Tests
python setup.py test
Roadmap
[x] Use dot to seperate folder/subfolder/file
[x] Unicode support
[x] JSON support
[x] YAML support
[x] INI support
[ ] XML support
[ ] Auto encoding detect?
[x] CI
[ ] coverage
[x] pypi
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.