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

{edwh_editorjs-1.0.1 → edwh_editorjs-1.1.0}/CHANGELOG.md

@@ -2,9 +2,21 @@
 
 <!--next-version-placeholder-->
 
+## v1.1.0 (2024-10-31)
+
+### Feature
+
+* Expose _sanitize via EditorJSBlock.sanitize for external usage ([`7daa67c`](https://github.com/educationwarehouse/edwh-editorjs/commit/7daa67c90440510c83b573c22edf377cc2fd801f))
+
+### Documentation
+
+* Added section on defining new custom blocks ([`51d7720`](https://github.com/educationwarehouse/edwh-editorjs/commit/51d77208d4f8156e895de914f41bdeb882a508c0))
+
 ## v1.0.1 (2024-10-31)
 
+### Documentation
 
+* Updated README ([`18d0216`](https://github.com/educationwarehouse/edwh-editorjs/commit/18d021629bcb223b89a9731e9ad8c574248f75c7))
 
 ## v1.0.0 (2024-10-31)
 
@@ -12,7 +24,3 @@
 
 * 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 → edwh_editorjs-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 1.0.1
+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>
@@ -25,7 +25,7 @@ Description-Content-Type: text/markdown
 
 # edwh-editorjs
 
-A minimal, fast Python 3.10+ package for parsing [Editor.js](https://editorjs.io) content. 
+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
@@ -46,7 +46,7 @@ pip install edwh-editorjs
 ### Quickstart
 
 ```python
-from edwh_editorjs import EditorJsParser
+from pyeditorjs import EditorJsParser
 
 editor_js_data = ...  # your Editor.js JSON data
 parser = EditorJsParser(editor_js_data)  # initialize the parser
@@ -58,15 +58,46 @@ print(html)  # your clean HTML
 ### Enforcing Strict Block Types
 
 ```python
-from edwh_editorjs import EditorJsParser, EditorJSUnsupportedBlock
+from pyeditorjs import EditorJsParser, EditorJSUnsupportedBlock
+
+editor_js_data: dict = ...
+parser = EditorJsParser(editor_js_data)
 
 try:
-    parser = EditorJsParser(editor_js_data, strict=True)
-    html = parser.html()
+    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. 

edwh_editorjs-1.1.0/README.md

@@ -0,0 +1,79 @@
+# 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/pyeditorjs/__about__.py

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

{edwh_editorjs-1.0.1 → edwh_editorjs-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",

{edwh_editorjs-1.0.1 → edwh_editorjs-1.1.0}/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.1/README.md

@@ -1,48 +0,0 @@
-# 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

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