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:

pip install django-admin-json-editor

Add application to the INSTALLED_APPS settings:

INSTALLED_APPS = [
    ...
    'django_admin_json_editor',
    ...
]

Define schema of json field:

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:

class JSONModelAdminForm(forms.ModelForm):
    class Meta:
        model = JSONModel
        fields = '__all__'
        widgets = {
            'data': JSONEditorWidget(DATA_SCHEMA, collapsed=False),
        }

Dynamic schema

It is possible to build dynamic schema for widget:

def dynamic_schema(widget):
    return {
        'type': 'array',
        'title': 'tags',
        'items': {
            'type': 'string',
            'enum': [i for i in Tag.objects.values_list('name', flat=True)],
        }
    }

@admin.register(JSONModel)
class JSONModelAdmin(admin.ModelAdmin):
    def get_form(self, request, obj=None, **kwargs):
        widget = JSONEditorWidget(dynamic_schema, False)
        form = super().get_form(request, obj, widgets={'tags': widget}, **kwargs)
        return form

Django admin inlines

JSONEditorWidget may be used also with django admin inlines, by overriding

1. the get_formset method of the StackedInline (or TabularInline) class, and

2. the get_form method of the ModelAdmin class,

like in the example below.

class RelatedJSONModelStackedInline(admin.StackedInline):
    model = RelatedJSONModel
    def get_formset(self, request, obj=None, **kwargs):
        widgets = {
            'related_data': JSONEditorWidget(RELATED_DATA_SCHEMA, False),
        }
        return super().get_formset(request, obj, widgets=widgets, **kwargs)
        
@admin.register(MyJSONModel)
class MyJSONModelAdmin(admin.ModelAdmin):
    inlines = [ RelatedJSONModelStackedInline, ]
    def get_form(self, request, obj=None, **kwargs):
        widgets = {
            'data': JSONEditorWidget(DATA_SCHEMA, collapsed=False),
        }
        return super().get_form(request, obj, widgets=widgets, **kwargs)