https://github.com/catallog/django-jsonschema-form
Django widgets to render jsonschema as admin forms
https://github.com/catallog/django-jsonschema-form
django django-admin django-forms django-widget javascript json jsonschema
Last synced: about 1 year ago
JSON representation
Django widgets to render jsonschema as admin forms
- Host: GitHub
- URL: https://github.com/catallog/django-jsonschema-form
- Owner: catallog
- License: mit
- Created: 2017-05-08T14:23:15.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-05-28T01:54:05.000Z (about 6 years ago)
- Last Synced: 2025-03-25T23:51:17.535Z (about 1 year ago)
- Topics: django, django-admin, django-forms, django-widget, javascript, json, jsonschema
- Language: Python
- Size: 97.7 KB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
django-jsonschema-form
====================
This package renders a [jsonschema](http://json-schema.org/) as part of one django admin form.
# Instalation
Just run ```pip install django-jsonschema-form``` and then add an entry on your django project's settings.
``` python
INSTALLED_APPS = [
...,
jsonschemaform,
]
```
# How it works
The core component is basicaly a django widget that receives a jsonschema and renders a form fragment.
It uses the [JSON Editor](https://github.com/jdorn/json-editor) js library to actually render this fragment.
In practice you only have to override the admin widget like the snipet bellow.
``` python
# Imporing Widget
from jsonschemaform.admin.widgets.jsonschema_widget import JSONSchemaWidget
# Here it is used postgres JSONField field implementation. Other implementation can be used depending on your DB
from django.contrib.postgres.fields import JSONField
# JSONSchema definition
schema = {
"title": "Config Schema",
"description": "My configutation schema",
"type": "object",
"properties": {
"columns": {
"description": "List of columns size",
"type": "array"
},
"class": {
"description": "A reference css class",
"type": "string"
},
"container": {
"default": "container",
"description": "Default page container",
"type": "string"
}
},
"required": [
"columns",
],
}
# Overriding widgets for all instances of JSONField on PageAdmin form
class PageAdmin(admin.ModelAdmin):
formfield_overrides = {
JSONField: {'widget': JSONSchemaWidget(schema)}
}
```
This form will looks like
# Tweaking the editor
It is possible to configure the editor through django settings using the key JSONSCHEMAFORM.
``` python
JSONSCHEMAFORM = {
'css': {
'all': (
'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css',
)
},
'options': {
'theme': 'bootstrap3',
'iconlib': 'bootstrap3',
'no_additional_properties': True,
'disable_collapse': True,
}
}
```
The settings above is also the default configuration.
But you can override or add any options described on [JSON Editor options](https://github.com/jdorn/json-editor#options).