https://github.com/bhch/django-jsonform

A better, user-friendly JSON editing form field for Django admin. Also supports Postgres ArrayField.
https://github.com/bhch/django-jsonform

admin django json-form json-schema python

Last synced: 5 days ago
JSON representation

A better, user-friendly JSON editing form field for Django admin. Also supports Postgres ArrayField.

• Host: GitHub
• URL: https://github.com/bhch/django-jsonform
• Owner: bhch
• License: bsd-3-clause
• Created: 2021-08-28T05:58:50.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T06:09:07.000Z (3 months ago)
• Last Synced: 2024-12-05T16:02:30.937Z (20 days ago)
• Topics: admin, django, json-form, json-schema, python
• Language: Python
• Homepage: https://django-jsonform.rtfd.io
• Size: 1.38 MB
• Stars: 352
• Watchers: 5
• Forks: 34
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

        


  





    A user-friendly JSON editing form for django admin.





  

  

  





  Documentation •

  Playground •

  PyPI



## Features

 - [x] File uploads

 - [x] Postgres `ArrayField`

 - [x] Many inputs and field types

 - [x] UI matches with Django admin's

 - [x] Recursion (nesting with self references)

 - [x] Validation

## Screenshots

Here's a screenshot of items being added to a shopping list (JSON array) dynamically:

![django-jsonform screenshot](https://raw.githubusercontent.com/bhch/django-jsonform/master/docs/_static/quickstart.gif)

## Install

Install via pip:

```sh

$ pip install django-jsonform

```

Edit your *settings.py* file:

```python

# settings.py

INSTALLED_APPS = [

    # ...

    'django_jsonform'

]

```

## Upgrading notes

When upgrading from an older version of this library, please ensure that your

browser is loading the latest static JavaScript files that come with this library.

 - In the development environment, clear the browser cache.

 - In the production environment, you must run the `collectstatic` command to update

 the static files.

## Documentation

Quickstart and usage docs can be found at [http://django-jsonform.rtfd.io](http://django-jsonform.rtfd.io).

## Contributing

 - The JavaScript code is written in React and it lives in another repo: https://github.com/bhch/react-json-form.  

   The JS code lacks proper documentation or comments, so before contributing, maybe open an issue and I can help you out.

 - For everything else (related to Django or widget's css), contribute directly to this repo.

## License

[BSD-3-Clause](LICENSE.txt)