Skip to main content

A convenience utility for working with JSON config files.

Project description

Development Status Documentation Status

A convenience utility for working with JSON configuration files.


  • Automatically syncs file on changes.

  • Automatically handles complicated nested data structures.

  • Lightweight (<5KB) and Fast.

  • Takes advantage of Python’s native dictionary syntax.

  • Tested against python 2.7, 3.2, 3.3, 3.4, and PYPY.

  • Saves silently in the background.

  • Unit Tested with high coverage.

  • Fully documented at

>>> import json_config
>>> config = json_config.connect('categories.json')
>>> config
>>> config['comics']['dc']['batman']['antagonists'] = ['Scarecrow', 'The Joker', 'Bane']
>>> config['comics']['marvel']['ironman']['antagonists'] = 'Ultron'
>>> config
  "comics": {
    "dc": {
      "batman": {
        "antagonists": [
          "The Joker",
    "marvel": {
      "ironman": {
        "antagonists": "Ultron"


At the command line either via easy_install or pip:

$ pip install json_config
$ easy_install json_config


$ pip uninstall json_config

Getting Started

To use json_config in a project:

import json_config

config = json_config.connect('config.json')
config['root'] = '/var/www/html/'

print config['root'] # '/var/www/html/'
print config # { "root": "/var/www/html" }


The full documentation is at


Next Release

  • Stay Tuned.

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

json_config-1.2.0.tar.gz (8.2 kB view hashes)

Uploaded source

Built Distribution

json_config-1.2.0-py2.py3-none-any.whl (6.7 kB view hashes)

Uploaded 2 7

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page