Metadata-Version: 1.1
Name: django-json-widget
Version: 1.1.0
Summary: Django json widget is an alternative widget that makes it easy to edit the jsonfield field of django.
Home-page: https://github.com/jmrivas86/django-json-widget
Author: José Manuel Rivas
Author-email: jmrivas86@gmail.com
License: MIT
Description: =============================
        django-json-widget
        =============================
        
        .. image:: https://badge.fury.io/py/django-json-widget.svg
            :target: https://badge.fury.io/py/django-json-widget
        
        .. image:: https://travis-ci.org/jmrivas86/django-json-widget.svg?branch=master
            :target: https://travis-ci.org/jmrivas86/django-json-widget
        
        .. image:: https://codecov.io/gh/jmrivas86/django-json-widget/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/jmrivas86/django-json-widget
        
        An alternative widget that makes it easy to edit the new Django's field JSONField (PostgreSQL specific model fields)
        
        
        Quickstart
        ----------
        
        Install django-json-widget::
        
            pip install django-json-widget
        
        Add it to your `INSTALLED_APPS`:
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...
                'django_json_widget',
                ...
            )
        
        Add the widget in your admin.py:
        
        .. code-block:: python
        
            from django.contrib import admin
            # from django.contrib.postgres import fields # if django < 3.1
            from django.db import models
            from django_json_widget.widgets import JSONEditorWidget
            from .models import YourModel
        
        
            @admin.register(YourModel)
            class YourModelAdmin(admin.ModelAdmin):
                formfield_overrides = {
                    # fields.JSONField: {'widget': JSONEditorWidget}, # if django < 3.1
                    models.JSONField: {'widget': JSONEditorWidget},
                }
        
        You can also add the widget in your forms.py:
        
        .. code-block:: python
        
            from django import forms
            from django_json_widget.widgets import JSONEditorWidget
            from .models import YourModel
        
        
            class YourForm(forms.ModelForm):
                class Meta:
                    model = YourModel
        
                    fields = ('jsonfield',)
        
                    widgets = {
                        'jsonfield': JSONEditorWidget
                    }
        
        Configuration
        -------------
        
        You can customize the JSONEditorWidget with the following options:
        
        * **width**: Width of the editor as a string with CSS size units (px, em, % etc). Defaults to ``90%``.
        * **height**: Height of the editor as a string CSS size units. Defaults to ``550px``.
        * **options**: A dict of options accepted by the `JSON editor`_. Options that require functions (eg. onError) are not supported. 
        * **mode (deprecated)**: The default editor mode. This argument is redundant because it can be specified as a part of ``options``.  Preserved for backwards compatibility with version 0.2.0.
        * **attrs**: HTML attributes to be applied to the wrapper element. See the `Django Widget documentation`_.
        
        .. _json editor: https://github.com/josdejong/jsoneditor/blob/master/docs/api.md#configuration-options
        .. _Django Widget documentation: https://docs.djangoproject.com/en/2.1/ref/forms/widgets/#django.forms.Widget.attrs
        
        
        JSONEditorWidget widget
        -----------------------
        
        Before:
        
        .. image:: https://raw.githubusercontent.com/jmrivas86/django-json-widget/master/imgs/jsonfield_0.png
        
        After:
        
        .. image:: https://raw.githubusercontent.com/jmrivas86/django-json-widget/master/imgs/jsonfield_1.png
        
        
        Credits
        -------
        
        Tools used in rendering this package:
        
        *  Cookiecutter_
        *  `cookiecutter-djangopackage`_
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
        
        
        
        
        History
        -------
        
        0.1.0 (2017-05-10)
        ++++++++++++++++++
        
        * First release on PyPI.
        
Keywords: django-json-widget
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
