jsonfield2

jsonfield2

.. image:: https://circleci.com/gh/rpkilby/jsonfield2.svg?style=shield :target: https://circleci.com/gh/rpkilby/jsonfield2 .. image:: https://codecov.io/gh/rpkilby/jsonfield2/branch/master/graph/badge.svg :target: https://codecov.io/gh/rpkilby/jsonfield2 .. image:: https://img.shields.io/pypi/v/jsonfield2.svg :target: https://pypi.org/project/jsonfield2 .. image:: https://img.shields.io/pypi/l/jsonfield2.svg :target: https://pypi.org/project/jsonfield2

ARCHIVE NOTICE: This package has been deprecated and merged back into jsonfield.

jsonfield2 is a reusable model field that allows you to store validated JSON, automatically handling serialization to and from the database. To use, add jsonfield.JSONField to one of your models.

Note: django.contrib.postgres_ now supports PostgreSQL's jsonb type, which includes extended querying capabilities. If you're an end user of PostgreSQL and want full-featured JSON support, then it is recommended that you use the built-in JSONField. However, jsonfield2 is still useful when your app needs to be database-agnostic, or when the built-in JSONField's extended querying is not being leveraged. e.g., a configuration field.

.. _django.contrib.postgres: https://docs.djangoproject.com/en/dev/ref/contrib/postgres/fields/#jsonfield

Requirements

jsonfield2 aims to support all current versions of Django_, however the explicity tested versions are:

• Python: 3.6, 3.7, 3.8
• Django: 2.2, 3.0

.. _versions of Django: https://www.djangoproject.com/download/#supported-versions

Installation

.. code-block:: python

pip install jsonfield2

Usage

.. code-block:: python

from django.db import models
from jsonfield import JSONField

class MyModel(models.Model):
    json = JSONField()

Advanced Usage

By default python deserializes json into dict objects. This behavior differs from the standard json behavior because python dicts do not have ordered keys. To overcome this limitation and keep the sort order of OrderedDict keys the deserialisation can be adjusted on model initialisation:

.. code-block:: python

import collections

class MyModel(models.Model):
    json = JSONField(load_kwargs={'object_pairs_hook': collections.OrderedDict})

Other Fields

jsonfield.JSONCharField

Subclasses models.CharField instead of models.TextField.

Running the tests

The test suite requires tox and tox-venv.

.. code-block:: shell

$ pip install tox tox-venv

To test against all supported versions of Django, install and run tox:

.. code-block:: shell

$ tox

Or, to test just one version (for example Django 2.0 on Python 3.6):

.. code-block:: shell

$ tox -e py36-django20

Release Process

• Update changelog
• Update package version in setup.py
• Check supported versions in setup.py and readme
• Create git tag for version
• Upload release to PyPI test server
• Upload release to official PyPI server

.. code-block:: shell

$ pip install -U pip setuptools wheel twine
$ rm -rf dist/ build/
$ python setup.py sdist bdist_wheel
$ twine upload -r test dist/*
$ twine upload dist/*

Changes

Take a look at the changelog_.

.. _changelog: https://github.com/rpkilby/jsonfield2/blob/master/CHANGES.rst