Skip to main content

JSON Schema forms for Django

Project description

https://travis-ci.org/Aristotle-Metadata-Enterprises/django-jsonforms.svg?branch=master

django-jsonforms provides the JSONSchemaField, a Django form field that renders a dynamic form created from a json schema. The form is created using json-editor (https://github.com/jdorn/json-editor). The field also validates submitted data against the json schema and can be rendered as a standard form field.

Installation

Install with pip pip install django-jsonforms

Add django_jsonforms to your INSTALLED_APPS

Make sure you have APP_DIRS set to True in your TEMPLATES setting More about the templates setting here: https://docs.djangoproject.com/en/2.0/ref/settings/#templates

Requirements

The python requirements jsonschema and django will be installed when installing the package through pip Additionally jQuery is required on the page that will be rendering the form.

Instructions for adding jQuery here: https://www.w3schools.com/jquery/jquery_get_started.asp

Usage

The field can be used like any other Django form field, it has the schema and options attributes which can be either python dictionaries or paths to staticfiles as as shown below

  • The schema parameter is the json schema the field will use
  • The options parameter is passed through to the json-editor object, these options are described here: https://github.com/jdorn/json-editor#options (the schema option is not used)
  • An optional ajax parameter determines whether any files are loaded via ajax on the frontend or loaded in the backend and put into html parameters (defaults to true)

Example:

from django.forms import ModelForm, Form
from django_jsonforms.forms import JSONSchemaField

class RegistrySettingsForm(Form):

    json = JSONSchemaField(
        schema = 'schema/schema.json',
        options = 'schema/options.json'
    )

In this example the schema file would be located in ‘static/schema/schema.json’. You will need to run collectstatic after creating the file

Example showing all options:

class RegistrySettingsForm(Form):

    json = JSONSchemaField(
        schema = 'schema/schema.json',
        options = {"theme": "bootstrap3"},
        ajax = false
    )

Since it is common to have only one field in this type of form. A form with a single JSONSchemaField named json is also available to use

Form Example:

from django_jsonforms.forms import JSONSchemaForm

form = JSONSchemaForm(schema=... , options=... , ajax=...)

Note:

When rendering the form don’t forget to render the forms media with the template tag {{ form.media }}. This is required for the field to function correctly

The data returned when the field is submitted is in the form of a python dictionary. This may need to be converted before being stored depending on the model field being used

Project details


Download files

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

Source Distribution

django-jsonforms-1.0.4.tar.gz (85.4 kB view hashes)

Uploaded source

Built Distribution

django_jsonforms-1.0.4-py3-none-any.whl (90.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page