=======================
Django JSONField-Schema
=======================
Expose Django JSONField data as virtual model fields
Use ModelForm and ModelAdmin as usual. Perform simple queries. Migrate to real
table columns when needed without code change.
Suitable to store dumb business data, quick prototypes without DB migrations,
and replace multi-table inheritance joins.
.. image:: https://img.shields.io/pypi/v/django-jsonfield-schema.svg
:target: https://pypi.python.org/pypi/django-jsonfield-schema
.. image:: https://img.shields.io/pypi/pyversions/django-jsonfield-schema.svg
:target: https://pypi.python.org/pypi/django-jsonfield-schema
.. image:: https://img.shields.io/pypi/djversions/django-jsonfield-schema.svg
:target: https://pypi.python.org/pypi/django-jsonfield-schema
*Use with caution! Replacing relational structures with JSON data should be
mindfull architecture decision.*
Works with any JSONField `django.contrib.postgres <https://docs.djangoproject.com/en/2.2/ref/contrib/postgres/fields/#jsonfield>`_,
`django-annoying <https://github.com/skorokithakis/django-annoying#jsonfield>`_,
`django-mysql <https://django-mysql.readthedocs.io/en/latest/model_fields/json_field.html>`_,
upcoming django `Cross-db JSONField <https://github.com/django/django/pull/11452>`_
*Work in progress* part of https://json-schema.org definitions are only supported.
Quick start
===========
.. code:: python
from django import forms
from django.contrib import admin
from django.db import models
from jsonfield_schema import JSONSchema
class EmployeeSchema(JSONSchema):
full_name = {
"type": "string"
}
hire_date = {
"type": "string",
"format": "date"
}
salary = {
"type": "number",
"multiplyOf": 0.01,
}
class Employee(models.Model):
_schema = EmployeeSchema()
data = JSONField(default={})
class EmployeeForm(forms.ModelForm):
class Meta:
model = Employee
fields = ['full_name', 'hire_date', 'salary']
@admin.register(Employee)
class EmployeeAdmin(admin.ModelAdmin):
list_display = ['full_name', 'hire_date']
fields = ['full_name', ('hire_date', 'salary')]
Demo
====
The demo shows how to handle multiple User types within single table with
JSONField and `Django-Polymodels <https://github.com/charettes/django-polymodels/>`_ proxies.
.. code:: bash
$ export DATABASE_URL=postgresql://viewflow:viewflow@localhost/viewflow
$ export DJANGO_SETTINGS_MODULE=demo.settings
$ tox python manage.py migrate
$ tox python manage.py runserver
License
=======
Django JSONField-Schema is an Open Source project licensed under the terms of
the AGPL license - `The GNU Affero General Public License v3.0
<http://www.gnu.org/licenses/agpl-3.0.html>`_ with the Additional Permissions
described in `LICENSE_EXCEPTION <./LICENSE_EXCEPTION>`_
You can more read about AGPL at `AGPL FAQ <http://www.affero.org/oagf.html>`_
This package license scheme follows to GCC Runtime library licensing. If you use
Linux already, probably this package license, should not bring anything new to
your stack.
Latest changelog
================
0.3.0 2019-11-01
----------------
* Support for date/time/datetime values
* Support for help_text (description) and verbose_name (verboseName) field specs
