Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SKevo18/pyEditorJS
A very simple Editor.js parser written in pure Python
https://github.com/SKevo18/pyEditorJS
editorjs editorjs-converter editorjs-tool python python3
Last synced: 3 months ago
JSON representation
A very simple Editor.js parser written in pure Python
- Host: GitHub
- URL: https://github.com/SKevo18/pyEditorJS
- Owner: SKevo18
- License: mit
- Created: 2021-10-23T10:40:31.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-10T12:28:34.000Z (over 1 year ago)
- Last Synced: 2024-05-19T15:35:23.301Z (6 months ago)
- Topics: editorjs, editorjs-converter, editorjs-tool, python, python3
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 16
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-editorjs - pyEditorJS - A very simple Editor.js parser written in pure Python (Libraries / Python)
README
# pyEditorJS
A minimal, fast, Python 3.6+ package for parsing [Editor.js](https://editorjs.io) content.
## Features
- Handles all out-of-the-box Editor.js elements;
- Optional sanitization via the `bleach` library;
- Checks whether the data is valid (e. g.: a header can't have more than 6 levels), and raises `EditorJsParseError` if data is malformed;
- Uses Editor.js's class names for styles, so the output will be consistent with WYSIWYG (see [Editor.js's example style](https://github.com/codex-team/editor.js/blob/8ae8823dcd6877d63241fcb94694a8a18744485d/example/assets/demo.css) and [styles documentation](https://editorjs.io/styles))## Installation
```bash
pip install pyeditorjs
```**Optional:** install [bleach](https://pypi.org/project/bleach) for clean HTML:
```bash
pip install bleach
```## Usage
### Quickstart
```python
from pyeditorjs import EditorJsParsereditor_js_data = ... # your Editor.js JSON data
parser = EditorJsParser(editor_js_data) # initialize the parserhtml = parser.html(sanitize=True) # `sanitize=True` requires `bleach` to be installed
print(html) # your clean HTML
```### Obtain texts only (for creating audio-only version, for example)
> **WARNING:** This does not sanitize the texts! Please, call `bleach.clean(...)` directly. This also doesn't obtain text from bold texts, markers, etc... - you should use [BeautifulSoup](https://pypi.org/project/beautifulsoup4/) for this.
```python
#import bleach
from pyeditorjs import EditorJsParsereditor_js_data = ... # your Editor.js JSON data
parser = EditorJsParser(editor_js_data) # initialize the parserall_texts = []
for block in parser:
text = getattr(block, 'text', None)if text:
all_texts.append(text) # all_texts.append(bleach.clean(text))print(all_texts)
```## Disclaimer
This is a community-provided project, and is not affiliated with the Editor.js team.
It was created in my spare time. I cannot make sure that it will receive consistent updates.Because of this, PRs, bug reports and suggestions are welcome!