Example

Author: abogushov

README.md

@@ -0,0 +1,53 @@
+	# Django Administration JSON Editor
+
+Application adds support for editing JSONField in Django Administration via https://github.com/jdorn/json-editor.
+
+## Quick start
+
+Install application via pip:
+
+```bash
+pip install git+https://github.com/abogushov/django-admin-json-editor
+```
+
+Add application to the INSTALLED_APPS settings:
+
+```python
+INSTALLED_APPS = [
+    ...
+    'json_editor',
+    ...
+]
+```
+
+Define schema of json field:
+
+```python
+DATA_SCHEMA = {
+    'type': 'object',
+    'title': 'Data',
+    'properties': {
+        'text': {
+            'title': 'Some text',
+            'type': 'string',
+            'format': 'textarea',
+        },
+        'status': {
+            'title': 'Status',
+            'type': 'boolean',
+        },
+    },
+}
+```
+
+Use JSONEditorWidget to bind editor to the form field:
+
+```python
+class JSONModelAdminForm(forms.ModelForm):
+    class Meta:
+        model = JSONModel
+        fields = '__all__'
+        widgets = {
+            'data': JSONEditorWidget(DATA_SCHEMA, collapsed=False),
+        }
+```

README.rst

@@ -0,0 +1,2 @@
+db.sqlite3
+env/

examples/json_editor_example/.gitignore

@@ -0,0 +1,18 @@
+# An example of using application
+
+To run example to this steps:
+
+```bash
+python3 -m venv env
+. env/bin/activate
+pip install -r requirements.txt
+createdb json_editor_example
+python manage.py migrate
+python manage.py createsuperuser
+python manage.py runserver
+```
+
+Open `http://localhost:8000/admin/app/jsonmodel/add/`. You will see:
+
+![Example](django-admin-json-editor/examples/json_editor_example/example.png)
+

examples/json_editor_example/README.md

@@ -0,0 +1,37 @@
+from django.contrib import admin
+from django import forms
+
+from json_editor import JSONEditorWidget
+
+from .models import JSONModel
+
+
+DATA_SCHEMA = {
+    'type': 'object',
+    'title': 'Data',
+    'properties': {
+        'text': {
+            'title': 'Some text',
+            'type': 'string',
+            'format': 'textarea',
+        },
+        'status': {
+            'title': 'Status',
+            'type': 'boolean',
+        },
+    },
+}
+
+
+class JSONModelAdminForm(forms.ModelForm):
+    class Meta:
+        model = JSONModel
+        fields = '__all__'
+        widgets = {
+            'data': JSONEditorWidget(DATA_SCHEMA, collapsed=False),
+        }
+
+
+@admin.register(JSONModel)
+class JSONModelAdmin(admin.ModelAdmin):
+    form = JSONModelAdminForm

examples/json_editor_example/app/__init__.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AppConfig(AppConfig):
+    name = 'app'

examples/json_editor_example/app/admin.py

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.2 on 2017-06-13 04:23
+from __future__ import unicode_literals
+
+import django.contrib.postgres.fields.jsonb
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='JSONModel',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('data', django.contrib.postgres.fields.jsonb.JSONField(default={'status': False, 'text': 'some text'})),
+            ],
+        ),
+    ]

examples/json_editor_example/app/apps.py

@@ -0,0 +1,8 @@
+from django.db import models
+from django.contrib.postgres.fields import JSONField
+
+class JSONModel(models.Model):
+	data = JSONField(default={
+		'text': 'some text',
+		'status': False,
+		})