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"
      }
    }
  }
}

Credits¶

Tools used in rendering this package:

• Cookiecutter
• bionikspoon/cookiecutter-pypackage forked from audreyr/cookiecutter-pypackage

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up json_config for local development.

1. Fork the json_config repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/json_config.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv json_config
   $ cd json_config/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b feature/name-of-your-feature
   $ git checkout -b hotfix/name-of-your-bugfix
   

Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 json_config tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4, 3.5, and PyPy. Check https://travis-ci.org/bionikspoon/json_config/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ py.test tests/test_json_config.py

Development Lead¶

• Manu Phatak <bionikspoon@gmail.com>

Contributors¶

None yet. Why not be the first?

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.

JSON Config¶

A convenience utility for working with JSON config files.

>>> import json_config, os
>>> config = json_config.connect('config.json')
>>> config['root'] = '/var/www/html'
>>> print(config['root'])
/var/www/html
>>> config
Connect({'root': '/var/www/html'})

>>> os.remove('config.json')

json_config.connect(config_file, file_type=None, **kwargs)[source]¶

Submodules¶

json_config._compat module¶

Python 2to3 compatibility handling.

class json_config._compat.NullHandler(level=0)[source]¶

Bases: logging.Handler

This handler does nothing. It’s intended to be used to avoid the “No handlers could be found for logger XXX” one-off warning. This is important for library code, which may contain code to log events. If a user of the library does not configure logging, the one-off warning might be produced; to avoid this, the library developer simply needs to instantiate a NullHandler and add it to the top-level logger of the library module or package.

createLock()[source]¶

emit(record)[source]¶

handle(record)[source]¶

json_config._compat.FileNotFoundError¶

alias of IOError

json_config.contracts module¶

class json_config.contracts.AbstractSaveFile[source]¶

Bases: object

config_file = NotImplemented¶

save()[source]¶

class json_config.contracts.AbstractSerializer[source]¶

Bases: object

deserialize(string)[source]¶

serialize(**options)[source]¶

serializer_ext = NotImplemented¶

class json_config.contracts.AbstractTraceRoot[source]¶

Bases: object

json_config.main module¶

class json_config.main.AutoConfigBase(config_file=None, **kwargs)[source]¶

Bases: json_config.main.AutoSyncMixin, json_config.main.AutoDict

class json_config.main.AutoDict(obj=None, _root=None, _parent=None, _key=None)[source]¶

Bases: json_config.main.TraceRootMixin, collections.defaultdict

save()[source]¶

update(E, **F) → None. Update D from E and F: for k in E: D[k][source]¶

= E[k] (if E has keys else: for (k, v) in E: D[k] = v) then: for k in

F: D[k] = F[k]

class json_config.main.AutoSyncMixin(**kwargs)[source]¶

Bases: json_config.contracts.AbstractSaveFile, json_config.contracts.AbstractTraceRoot, json_config.contracts.AbstractSerializer

config_file = None¶

save()[source]¶

class json_config.main.PrettyJSONMixin[source]¶

Bases: json_config.contracts.AbstractSerializer

deserialize(string)[source]¶

serialize(**options)[source]¶

serializer_ext = 'json'¶

serializer_indent = 2¶

serializer_sort_keys = True¶

class json_config.main.TraceRootMixin[source]¶

Bases: json_config.contracts.AbstractTraceRoot

lock(*args, **kwds)[source]¶

json_config.main.connect(config_file, file_type=None, **kwargs)[source]¶