How to add json field to django-constance

info.md

How to add a json field to django-constance

1. Install django-jsonform

   pip install django-jsonform

2. Add django-jsonform to installed apps

   INSTALLED_APPS = [
       ...
       "django_jsonform",
       ...
   ]

3. Add additional field to constance in django settings

CONSTANCE_ADDITIONAL_FIELDS = {
    "my_band_list": [
        "django_jsonform.forms.fields.JSONFormField",
        {
            "schema": {
                "type": "array",
                "items": {
                    "type": "dict",
                    "keys": {
                        "genre": {
                            "type": "string",
                        },
                        "band": {
                            "type": "string",
                        },
                    },
                },
            }
        },
    ],
}

4. Add constance field in django settings

   CONSTANCE_CONFIG = {
       "MY_FAVORITE_BANDS": (
           [{"genre": "Krautrock", "band": "Can"}],
           "List of my favorite bands",
           "my_band_list",
       ),
   }

5. Done! You should now have a json editable field in constance