A convenience utility for working with JSON config files.
Project description
json_config
A convenience utility for working with JSON config files.
Features
Documentation: https://json_config.readthedocs.org
Open Source: https://github.com/bionikspoon/json_config
MIT license
Automatically syncs file on changes.
Automatically handles complicated nested data structures.
Designed to be easily extended. Use different serializer libraries to easily switch to yaml, ini, etc.
Lightweight (<5KB) and Fast.
Takes advantage of Python’s native dictionary syntax.
Tested against python 2.6, 2.7, 3.3, 3.4, 3.5, and PYPY!
Unit Tested with high coverage.
Idiomatic, self-descriptive code & api
>>> import json_config
>>> config = json_config.connect('categories.json')
>>> config
Connect({})
>>> config['comics']['dc']['batman']['antagonists'] = ['Scarecrow', 'The Joker', 'Bane']
>>> config['comics']['marvel']['ironman']['antagonists'] = 'Ultron'
>>> print(config.serialize())
{
"comics": {
"dc": {
"batman": {
"antagonists": [
"Scarecrow",
"The Joker",
"Bane"
]
}
},
"marvel": {
"ironman": {
"antagonists": "Ultron"
}
}
}
}
Installation
At the command line either via easy_install or pip
$ pip install json_config
$ easy_install json_config
Or, if you have virtualenvwrapper installed
$ mkvirtualenv json_config
$ pip install json_config
Uninstall
$ pip uninstall json_config
Usage
To use json_config in a project:
import json_config
config = json_config.connect('config.json')
config['root'] = '/var/www/html/'
print(config['root'])
#OUT: '/var/www/html/'
config
#OUT: Connect({'root': '/var/www/html/'})
Credits
Tools used in rendering this package:
History
Next Release
Stay tuned
2.0.0 (2016-01-01)
BREAKING: (Internal API) connect.block removed
BREAKING: (Internal API) connect.write_file renamed to connect.save
Feature: Rewrote the entire library to encapsulate logic
Feature: Extendable serializer contract, to allow any config format.
Feature: Upgrade to stable.
Feature: Removed threading in favor of a smarter locking mechanism
Feature: Add support for py26 and py35
Feature: Pin dependencies
Feature: Reorganized package and tests
Fix: Updated doc builds
Fix: Readme badge links
2.0.1: Fix: Failed deploy (travis requirements)
1.2.0 (2015-05-18)
Feature: Improved compatibility to py27, py32, py33, py34, and pypy
Feature: Supports multiple config files.
Feature: Writes less, smarter logic on deciding if a write is necessary.
Feature: Delegates writes to a background process.
Testing: Renamed tests to be more descriptive of expectations.
Testing: Added a bunch of tests describing different scenarios.
Massive Refactoring
1.1.0 (2015-04-15)
Massive improvement to documentation and presentation.
1.0.0 (2015-04-13)
First working version.
0.1.0 (2015-04-11)
First release on PyPI.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for json_config-2.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db006461ba2dc77bb63ee65f483da30f31b8ad8b4a2e724f6db2898c7456e679 |
|
MD5 | 2937e9848a53137854ae705a1928305f |
|
BLAKE2b-256 | 6a1e3d254b26a773d1ee4ddf110ab5c947b22b6634a04503811294ac9497c30b |