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

{edwh_editorjs-1.0.1.dist-info → edwh_editorjs-1.1.0.dist-info}/METADATA

@@ -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.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.1"
+__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.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-pyeditorjs/__about__.py,sha256=d4QHYmS_30j0hPN8NmNPnQ_Z0TphDRbu4MtQj9cT9e8,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.1.dist-info/METADATA,sha256=iepsBS_cxIexYAfYzBaL3dApQ3yTAE0bw838NKyfUys,2422
-edwh_editorjs-1.0.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-edwh_editorjs-1.0.1.dist-info/licenses/LICENSE,sha256=bY9MhHLeuW8w1aAl-i1O1uSNP5IMOGaL6AWvHcdnt0k,1062
-edwh_editorjs-1.0.1.dist-info/RECORD,,