A reusable Django field that allows you to store validated JSON in your model.
Project description
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.
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
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
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
$ 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.
Project details
Release history Release notifications | RSS feed
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 jsonfield2-4.0.0.post0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bab284d3fc721067d5f3107a0adc87ee772e9b09cac5eca042fad6311c4842bd |
|
MD5 | 9271b4f46f400ec852bdd397170d9e47 |
|
BLAKE2b-256 | 62ca4ad4bcd8d728721ac307adbaf9cb7371424773f8affcb425e3edd73e504c |