edwh-editorjs 1.0.0__py3-none-any.whl → 1.1.0__py3-none-any.whl

edwh_editorjs-1.1.0.dist-info/METADATA

@@ -0,0 +1,104 @@
+Metadata-Version: 2.3
+Name: edwh-editorjs
+Version: 1.1.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
+
+# 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 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` uses the included `bleach` dependency
+print(html)  # your clean HTML
+```
+
+### Enforcing Strict Block Types
+
+```python
+from pyeditorjs import EditorJsParser, EditorJSUnsupportedBlock
+
+editor_js_data: dict = ...
+parser = EditorJsParser(editor_js_data)
+
+try:
+    html = parser.html(strict=True)
+except EditorJSUnsupportedBlock as e:
+    print(f"Unsupported block type encountered: {e}")
+```
+
+### Adding a Custom Block
+
+To add a custom block type, create a new class that subclasses `EditorJsBlock` and decorates it with `@block("name")`,
+where `"name"` is the custom block type. Implement an `html` method to define how the block’s content should be
+rendered. This method should accept a `sanitize` parameter and can access block data via `self.data`.
+
+```python
+from pyeditorjs import EditorJsParser, EditorJsBlock, block
+
+@block("custom")
+class CustomBlock(EditorJsBlock):
+    def html(self, sanitize: bool = False) -> str:
+        # Access data with self.data and return the rendered HTML
+        content = self.data.get("something", "")
+        if sanitize:
+            content = self.sanitize(content)
+        
+        return f"<div class='custom-block'>{content}</div>"
+
+# Usage
+class CustomEditorJsParser(EditorJsParser):
+    pass  # Custom blocks are automatically detected
+
+editor_js_data = ...  # Editor.js JSON data with a "customBlock" type
+parser = CustomEditorJsParser(editor_js_data)
+html = parser.html()
+print(html)  # Includes rendered custom blocks
+```
+
+## 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.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pyeditorjs/__about__.py,sha256=LGVQyDsWifdACo7qztwb8RWWHds1E7uQ-ZqD8SAjyw4,22
+pyeditorjs/__init__.py,sha256=63UoNCWJo6NuPXXYnANQE3SKm1PQu2ggs89KCXSq-44,807
+pyeditorjs/blocks.py,sha256=4A8dXbh_oUKCctOHtMV6BrR7-UpyqFREPvwPEe_6vUo,8304
+pyeditorjs/exceptions.py,sha256=Uni8r3FwJ-6xQIdSmBsHLs_htWLHD0Arp1KJEvjGU1U,439
+pyeditorjs/parser.py,sha256=6DCqqi-FuXDFxn9xb-dgQ19alvVu7Pjx6x3rTAx9IsI,2154
+edwh_editorjs-1.1.0.dist-info/METADATA,sha256=Aq3-6WNcqqhbufFvnigNO-txrmV_6OppGmliWoK7tf4,3519
+edwh_editorjs-1.1.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+edwh_editorjs-1.1.0.dist-info/licenses/LICENSE,sha256=bY9MhHLeuW8w1aAl-i1O1uSNP5IMOGaL6AWvHcdnt0k,1062
+edwh_editorjs-1.1.0.dist-info/RECORD,,

pyeditorjs/__about__.py

@@ -1 +1 @@
-__version__ = "1.0.0"
+__version__ = "1.1.0"

pyeditorjs/__init__.py

@@ -1,12 +1,14 @@
 from pathlib import Path
 
 from .blocks import BLOCKS_MAP, EditorJsBlock, block
-from .exceptions import EditorJsParseError
+from .exceptions import EditorJsException, EditorJsParseError, EditorJSUnsupportedBlock
 from .parser import EditorJsParser
 
 __all__ = [
     "EditorJsParser",
     "EditorJsParseError",
+    "EditorJsException",
+    "EditorJSUnsupportedBlock",
     "EditorJsBlock",
     "block",
     "BLOCKS_MAP",

pyeditorjs/blocks.py

@@ -47,6 +47,10 @@ class EditorJsBlock(abc.ABC):
     _data: dict
     """The raw JSON data of the entire block"""
 
+    @classmethod
+    def sanitize(cls, html: str) -> str:
+        return _sanitize(html)
+
     @property
     def id(self) -> t.Optional[str]:
         """

edwh_editorjs-1.0.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -1,9 +0,0 @@
-pyeditorjs/__about__.py,sha256=J-j-u0itpEFT6irdmWmixQqYMadNl1X91TxUmoiLHMI,22
-pyeditorjs/__init__.py,sha256=Z0jH2OV2NkieVFU_URtWWhVsIMihIc4IGbUvCW_2Tm0,705
-pyeditorjs/blocks.py,sha256=qksJTNfKShzxinWVIk9DiCGRCJ5C7lp5jLG4Hbl1enk,8214
-pyeditorjs/exceptions.py,sha256=Uni8r3FwJ-6xQIdSmBsHLs_htWLHD0Arp1KJEvjGU1U,439
-pyeditorjs/parser.py,sha256=6DCqqi-FuXDFxn9xb-dgQ19alvVu7Pjx6x3rTAx9IsI,2154
-edwh_editorjs-1.0.0.dist-info/METADATA,sha256=CIRh9bLb2wwbKecMPayxr8TyY4z3GkYlr2L7FJIjCxI,3269
-edwh_editorjs-1.0.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-edwh_editorjs-1.0.0.dist-info/licenses/LICENSE,sha256=bY9MhHLeuW8w1aAl-i1O1uSNP5IMOGaL6AWvHcdnt0k,1062
-edwh_editorjs-1.0.0.dist-info/RECORD,,