Skip to main content

A reusable Django field that allows you to store validated JSON in your model.

Project description

https://travis-ci.org/rpkilby/jsonfield2.svg?branch=master https://codecov.io/gh/rpkilby/jsonfield2/branch/master/graph/badge.svg https://img.shields.io/pypi/v/jsonfield2.svg https://img.shields.io/pypi/l/jsonfield2.svg

A modern fork of django-jsonfield, compatible with the latest versions of Django.


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.

Requirements

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

  • Python: 3.4, 3.5, 3.6

  • Django: 1.11, 2.0

Installation

pip install jsonfield2

Usage

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:

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.

$ pip install tox tox-venv

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

$ tox

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

$ tox -e py36-django20

Release Process

  • Update changelog

  • Update package version in setup.py

  • Create git tag for version

  • Upload release to PyPI

$ pip install -U pip setuptools wheel
$ rm -rf dist/ build/
$ python setup.py bdist_wheel upload

Changes

Take a look at the changelog.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

jsonfield2-3.0.0-py2.py3-none-any.whl (5.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file jsonfield2-3.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for jsonfield2-3.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ac20e4fda644e6053c789844a880b18b20ad8157a9e442c38e79486951a7356e
MD5 d39a12008ff644d9fe1c4dc8c6e023c5
BLAKE2b-256 88377104aa07fc6bc1b87a0dbdcaf0857f67c074bf1ffeac4ecb0b260145841b

See more details on using hashes here.

Supported by

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