edwh-editorjs 1.0.0__tar.gz → 1.0.1__tar.gz

edwh_editorjs-1.0.1/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+<!--next-version-placeholder-->
+
+## v1.0.1 (2024-10-31)
+
+
+
+## v1.0.0 (2024-10-31)
+
+### Feature
+
+* Implemented more blocks (raw, warning, code, table, quote) ([`fb93bd9`](https://github.com/educationwarehouse/edwh-editorjs/commit/fb93bd959f06fa86bc23c9bfc51a8b7fddfc65f2))
+* Refactor to Registry Pattern so new block can be easily added ([`b06c86d`](https://github.com/educationwarehouse/edwh-editorjs/commit/b06c86da623dd2a2d92f7c48353a1f3208fb5749))
+
+### Documentation
+
+* Updated README ([`18d0216`](https://github.com/educationwarehouse/edwh-editorjs/commit/18d021629bcb223b89a9731e9ad8c574248f75c7))

edwh_editorjs-1.0.1/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.3
+Name: edwh-editorjs
+Version: 1.0.1
+Summary: pyEditorJS
+Project-URL: Homepage, https://github.com/educationwarehouse/edwh-EditorJS
+Author-email: SKevo <skevo.cw@gmail.com>, Robin van der Noord <robin.vdn@educationwarehouse.nl>
+License: MIT
+License-File: LICENSE
+Keywords: bleach,clean,editor,editor.js,html,javascript,json,parser,wysiwyg
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: bleach
+Provides-Extra: dev
+Requires-Dist: edwh; extra == 'dev'
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: su6[all]; extra == 'dev'
+Requires-Dist: types-bleach; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# edwh-editorjs
+
+A minimal, fast Python 3.10+ package for parsing [Editor.js](https://editorjs.io) content. 
+This package is a fork of [pyEditorJS by SKevo](https://github.com/SKevo18/pyEditorJS) with additional capabilities.
+
+## New Features
+
+- Expanded support for additional block types: Quote, Table, Code, Warning, and Raw blocks
+- Issues a warning if an unknown block type is encountered, rather than ignoring it
+- Adds a `strict` mode, raising an `EditorJSUnsupportedBlock` exception for unknown block types when `strict=True`
+- Allows adding new blocks by decorating a subclass of `EditorJsParser` with `@block("name")`
+
+## Installation
+
+```bash
+pip install edwh-editorjs
+```
+
+## Usage
+
+### Quickstart
+
+```python
+from edwh_editorjs import EditorJsParser
+
+editor_js_data = ...  # your Editor.js JSON data
+parser = EditorJsParser(editor_js_data)  # initialize the parser
+
+html = parser.html(sanitize=True)  # `sanitize=True` uses the included `bleach` dependency
+print(html)  # your clean HTML
+```
+
+### Enforcing Strict Block Types
+
+```python
+from edwh_editorjs import EditorJsParser, EditorJSUnsupportedBlock
+
+try:
+    parser = EditorJsParser(editor_js_data, strict=True)
+    html = parser.html()
+except EditorJSUnsupportedBlock as e:
+    print(f"Unsupported block type encountered: {e}")
+```
+
+## Disclaimer
+
+This is a community-provided project and is not affiliated with the Editor.js team. 
+Contributions, bug reports, and suggestions are welcome!

edwh_editorjs-1.0.1/README.md

@@ -0,0 +1,48 @@
+# edwh-editorjs
+
+A minimal, fast Python 3.10+ package for parsing [Editor.js](https://editorjs.io) content. 
+This package is a fork of [pyEditorJS by SKevo](https://github.com/SKevo18/pyEditorJS) with additional capabilities.
+
+## New Features
+
+- Expanded support for additional block types: Quote, Table, Code, Warning, and Raw blocks
+- Issues a warning if an unknown block type is encountered, rather than ignoring it
+- Adds a `strict` mode, raising an `EditorJSUnsupportedBlock` exception for unknown block types when `strict=True`
+- Allows adding new blocks by decorating a subclass of `EditorJsParser` with `@block("name")`
+
+## Installation
+
+```bash
+pip install edwh-editorjs
+```
+
+## Usage
+
+### Quickstart
+
+```python
+from edwh_editorjs import EditorJsParser
+
+editor_js_data = ...  # your Editor.js JSON data
+parser = EditorJsParser(editor_js_data)  # initialize the parser
+
+html = parser.html(sanitize=True)  # `sanitize=True` uses the included `bleach` dependency
+print(html)  # your clean HTML
+```
+
+### Enforcing Strict Block Types
+
+```python
+from edwh_editorjs import EditorJsParser, EditorJSUnsupportedBlock
+
+try:
+    parser = EditorJsParser(editor_js_data, strict=True)
+    html = parser.html()
+except EditorJSUnsupportedBlock as e:
+    print(f"Unsupported block type encountered: {e}")
+```
+
+## Disclaimer
+
+This is a community-provided project and is not affiliated with the Editor.js team. 
+Contributions, bug reports, and suggestions are welcome!

edwh_editorjs-1.0.1/pyeditorjs/__about__.py

@@ -0,0 +1 @@
+__version__ = "1.0.1"

edwh_editorjs-1.0.0/PKG-INFO

@@ -1,92 +0,0 @@
-Metadata-Version: 2.3
-Name: edwh-editorjs
-Version: 1.0.0
-Summary: pyEditorJS
-Project-URL: Homepage, https://github.com/educationwarehouse/edwh-EditorJS
-Author-email: SKevo <skevo.cw@gmail.com>, Robin van der Noord <robin.vdn@educationwarehouse.nl>
-License: MIT
-License-File: LICENSE
-Keywords: bleach,clean,editor,editor.js,html,javascript,json,parser,wysiwyg
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.10
-Requires-Dist: bleach
-Provides-Extra: dev
-Requires-Dist: edwh; extra == 'dev'
-Requires-Dist: hatch; extra == 'dev'
-Requires-Dist: su6[all]; extra == 'dev'
-Requires-Dist: types-bleach; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# 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 EditorJsParser
-
-editor_js_data = ... # your Editor.js JSON data
-parser = EditorJsParser(editor_js_data) # initialize the parser
-
-html = 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 EditorJsParser
-
-editor_js_data = ... # your Editor.js JSON data
-parser = EditorJsParser(editor_js_data) # initialize the parser
-
-all_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!
-
-<a href="https://www.buymeacoffee.com/skevo"><img src="https://img.buymeacoffee.com/button-api/?text=Support me&emoji=🐣&slug=skevo&button_colour=ffa200&font_colour=000000&font_family=Poppins&outline_colour=000000&coffee_colour=FFDD00" /></a>

edwh_editorjs-1.0.0/README.md

@@ -1,67 +0,0 @@
-# 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 EditorJsParser
-
-editor_js_data = ... # your Editor.js JSON data
-parser = EditorJsParser(editor_js_data) # initialize the parser
-
-html = 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 EditorJsParser
-
-editor_js_data = ... # your Editor.js JSON data
-parser = EditorJsParser(editor_js_data) # initialize the parser
-
-all_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!
-
-<a href="https://www.buymeacoffee.com/skevo"><img src="https://img.buymeacoffee.com/button-api/?text=Support me&emoji=🐣&slug=skevo&button_colour=ffa200&font_colour=000000&font_family=Poppins&outline_colour=000000&coffee_colour=FFDD00" /></a>

edwh_editorjs-1.0.0/pyeditorjs/__about__.py

@@ -1 +0,0 @@
-__version__ = "1.0.0"