Example

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),
+        }
+```

examples/json_editor_example/.gitignore

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

examples/json_editor_example/README.md

@@ -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/app/admin.py

@@ -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/apps.py

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

examples/json_editor_example/app/migrations/0001_initial.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/models.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,
+		})

examples/json_editor_example/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError:
+        # The above import may fail for some other reason. Ensure that the
+        # issue is really that Django is missing to avoid masking other
+        # exceptions on Python 2.
+        try:
+            import django
+        except ImportError:
+            raise ImportError(
+                "Couldn't import Django. Are you sure it's installed and "
+                "available on your PYTHONPATH environment variable? Did you "
+                "forget to activate a virtual environment?"
+            )
+        raise
+    execute_from_command_line(sys.argv)

examples/json_editor_example/project/settings.py

@@ -0,0 +1,124 @@
+"""
+Django settings for json_editor_example project.
+
+Generated by 'django-admin startproject' using Django 1.11.2.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.11/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.11/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'w@r7o+u6xj*7p#bhvmrip$jx%^2cmjzb2yk%dgl7#ldsq3ulcc'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+
+    'json_editor',
+
+    'app',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'project.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'project.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.11/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'json_editor_example',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.11/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.11/howto/static-files/
+
+STATIC_URL = '/static/'

examples/json_editor_example/project/urls.py

@@ -0,0 +1,21 @@
+"""json_editor_example URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/1.11/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  url(r'^$', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  url(r'^$', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.conf.urls import url, include
+    2. Add a URL to urlpatterns:  url(r'^blog/', include('blog.urls'))
+"""
+from django.conf.urls import url
+from django.contrib import admin
+
+urlpatterns = [
+    url(r'^admin/', admin.site.urls),
+]

examples/json_editor_example/project/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for json_editor_example project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "json_editor_example.settings")
+
+application = get_wsgi_application()

examples/json_editor_example/requirements.txt

@@ -0,0 +1,3 @@
+psycopg2==2.7.1
+Django==1.11.2
+git+https://github.com/abogushov/[email protected]