https://github.com/leixingyu/jsoneditor

Json Editor in Python
https://github.com/leixingyu/jsoneditor

json json-editor json-viewer mvc python

Last synced: 12 days ago
JSON representation

Json Editor in Python

• Host: GitHub
• URL: https://github.com/leixingyu/jsoneditor
• Owner: leixingyu
• License: mit
• Created: 2021-12-11T16:54:25.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T15:45:05.000Z (almost 2 years ago)
• Last Synced: 2023-03-09T23:47:03.109Z (over 1 year ago)
• Topics: json, json-editor, json-viewer, mvc, python
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 11
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


Json Editor


  


    A python script for editing `.json` file based on Qt framework

    


    Demo

  



## About The Project










`.json` files are heavily dependent in production environment and there are

many benefits of creating a standalone editor instead of editing the text file directly. 

Not everyone is fan of working with a text editor (like artists) and no one

can be confident to avoid syntax error in their edits.

Moreover, a standalone tool supports features like version control,

validation, schema and more.

The goal of this tool initially serves as my [model view programming practice in PyQt](https://github.com/leixingyu/model-view-tutorial),

but then I thought, why not iterate on it and make it user-friendly, portable and minimal? My goal now is to make this

modular and easily embeddable, so to create a standardized way for displaying and editing `.json` file across applications.

## Getting Started

### Prerequisites

- [Qt](https://github.com/mottosso/Qt.py): a module that supports different

python qt bindings

   or alternatively, change the code below to whatever qt binding you have on your machine.

   ```python

   from Qt import QtWidgets, QtCore, QtGui

   from Qt import _loadUi

   ```

### Launch

1. Unzip the **json-editor** package and rename is to something like `jsonViewer`

2. You can either run `main.py` directly or:

    ```python

    from jsonViewer import main

    main.show()

    ```

## Features

### Validation, sort and filtering

- Data validation is a built-in feature that comes with the model/view architecture

as type is preserved during `setData()` and `data()` methods. It then gets translated

into qt element: `str` as `QLineEdit`; `int` as `QSpinBox`; `float` as `QDoubleSpinBox`

- `list` and `dict` type data fully utilized the hierarchical support of `QAbstractItemModel`.

- Sorting and Filtering are enabled with the help of `QSortFilterProxyModel`.

![](https://i.imgur.com/ngslOnZ.gif)  

### Serialization

Serialization and de-serialization in the `QJsonModel` enables functionalities like copy/paste (left) 

and drag/drop (right).

| Copy and Paste | Drag and Drop |

|-----|----|

| ![copy/paste](https://i.imgur.com/UVlgHmQ.gif) | ![drag/drop](https://i.imgur.com/1uHIhOA.gif) |

### Raw View

The tool also has a built-in text editor with syntax highlighting known as the **raw view**.

As shown, the data between the **tree view** and the **raw view** are interchangeable.

![](https://i.imgur.com/o8IH5q9.gif)

## Roadmap

- [x] Json text view with syntax highlight

- [ ] Json schema support

- [ ] File drop

- [ ] Custom stylesheet

- [ ] Scripting interface for modular support

- [ ] Web deployment (maybe?)

### Reference

[Model View Programming](https://github.com/leixingyu/model-view-tutorial)

[QJsonModel](https://github.com/dridk/QJsonModel)