Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevinmickey/django-prettyjson
Enables pretty JSON viewer in Django forms, admin, or templates
https://github.com/kevinmickey/django-prettyjson
Last synced: 3 months ago
JSON representation
Enables pretty JSON viewer in Django forms, admin, or templates
- Host: GitHub
- URL: https://github.com/kevinmickey/django-prettyjson
- Owner: kevinmickey
- License: bsd-3-clause
- Created: 2016-05-28T15:06:58.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-03T14:04:21.000Z (5 months ago)
- Last Synced: 2024-07-19T01:19:15.866Z (4 months ago)
- Language: Python
- Size: 352 KB
- Stars: 139
- Watchers: 4
- Forks: 21
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
- starred-awesome - django-prettyjson - Enables pretty JSON viewer in Django forms, admin, or templates (Python)
README
# django-prettyjson
[](https://badge.fury.io/py/django-prettyjson) [](https://travis-ci.org/kevinmickey/django-prettyjson)
Enables pretty JSON viewer in Django forms, admin, or templates. The viewer is adapted from [jQuery JSONView](https://github.com/yesmeck/jquery-jsonview). It is compatible with almost anything: JSON stored in a string, a jsonfield (using django.contrib.postgres or [django-jsonfield](https://github.com/bradjasper/django-jsonfield/)), or any python object that can be serialized to JSON (using [standardjson](https://github.com/audreyr/standardjson)).
## Demo
See http://kevinmickey.github.io/django-prettyjson
## Installation
At the command line:
```sh
pip install django-prettyjson
```
## Configuration
Add `'prettyjson'` to `INSTALLED_APPS` in `settings.py`:
```python
INSTALLED_APPS = (
...,
'prettyjson',
)
```
## Usage
In a form or admin of a model, enable a pretty JSON viewer for a particular field:
```python
from prettyjson import PrettyJSONWidget
class JsonForm(forms.ModelForm):
class Meta:
model = Test
fields = '__all__'
widgets = {
'myjsonfield': PrettyJSONWidget(),
}
class JsonAdmin(admin.ModelAdmin):
form = JsonForm
```
Enable pretty JSON viewer for every JSONField of a model:
```python
from django.contrib.postgres.fields import JSONField
class JsonAdmin(admin.ModelAdmin):
formfield_overrides = {
JSONField: {'widget': PrettyJSONWidget }
}
```
In templates, you can also enable a pretty JSON viewer. Use the `prettyjson` template tag with a string JSON or with objects (dicts, QuerySets, etc.) that can be serialized to a JSON. Note that the template tag must be loaded using `{% load prettyjson %}`. It also has CSS and JS that must be included using `{% prettyjson_setup %}`.
```htmldjango
{% extends "base.html" %}
{% load prettyjson %}
{% block header %}
{{ block.super }}
{% prettyjson_setup %}
{% endblock %}
{% block content %}
{% prettyjson myqueryset %}
{% prettyjson mydict %}
{% prettyjson '{"hey": "guy","anumber": 243,"anobject": {"whoa": "nuts","anarray": [1,2,"thr
ee"], "more":"stuff"},"awesome": true,"bogus": false,"meaning": null, "japanese":"明日がある。", "link": "http://jsonview.com", "notLink": "http://jsonview.com is great"}' %}
{% prettyjson '{}' %}
{% endblock %}
```
The setup includes jQuery, loaded as django.jQuery to avoid namespace conflict. If your page already includes jQuery, use `{% prettyjson_setup jquery=False %}` to avoid loading jQuery a second time.
### Configure Rendering
By default the jsonwidget will render as a raw string with a button to click to change it to parsed json. For it to render as parsed json initially, you can pass an argument:
```python
class JsonAdmin(admin.ModelAdmin):
formfield_overrides = {
JSONField: {'widget': PrettyJSONWidget(attrs={'initial': 'parsed'})}
}
```
Or, in a template tag:
```python
{% prettyjson mydict initial='parsed' %}
```
## Running Tests
In development.
```sh
source /bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.py
```
## Credits
Dependencies, parts of code, and/or sources of inspiration:
* [jQuery JSONView](https://github.com/yesmeck/jquery-jsonview)
* [standardjson](https://github.com/audreyr/standardjson)
Tools used in developing, testing, and/or rendering this package:
* [Cookiecutter](https://github.com/audreyr/cookiecutter)
* [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)