edwh-editorjs 2.3.2__tar.gz → 2.5.0__tar.gz

{edwh_editorjs-2.3.2 → edwh_editorjs-2.5.0}/.gitignore

@@ -11,6 +11,7 @@ dist/*
 .env
 venv*
 *coverage*
+htmlcov/*
 dist/
 build/
 example.*

{edwh_editorjs-2.3.2 → edwh_editorjs-2.5.0}/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 <!--next-version-placeholder-->
 
+## v2.5.0 (2025-03-20)
+
+### Feature
+
+* Improve markdown conversion and image handling in EditorJS blocks ([`80d0fc0`](https://github.com/educationwarehouse/edwh-editorjs/commit/80d0fc00a4e39b279de35998d1a85a37282c58a7))
+
+## v2.4.0 (2024-12-02)
+
+### Feature
+
+* **image:** Support more options for the image block ([`c74dcce`](https://github.com/educationwarehouse/edwh-editorjs/commit/c74dccef5c1115038f6de0f08250dfa6cff18796))
+
+### Fix
+
+* Less exceptions, more warnings for better ease-of-use ([`891fca1`](https://github.com/educationwarehouse/edwh-editorjs/commit/891fca198e774c53a8b6365b927a080f61c0b2c8))
+
 ## v2.3.2 (2024-11-27)
 
 ### Fix

{edwh_editorjs-2.3.2 → edwh_editorjs-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: edwh-editorjs
-Version: 2.3.2
+Version: 2.5.0
 Summary: EditorJS.py
 Project-URL: Homepage, https://github.com/educationwarehouse/edwh-EditorJS
 Author-email: SKevo <skevo.cw@gmail.com>, Robin van der Noord <robin.vdn@educationwarehouse.nl>
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
+Requires-Dist: html2markdown
 Requires-Dist: humanize
 Requires-Dist: markdown2
 Requires-Dist: mdast

edwh_editorjs-2.5.0/editorjs/__about__.py

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

{edwh_editorjs-2.3.2 → edwh_editorjs-2.5.0}/editorjs/blocks.py

@@ -8,6 +8,7 @@ import typing as t
 from html.parser import HTMLParser
 from urllib.parse import urlparse
 
+import html2markdown
 import humanize
 import markdown2
 
@@ -53,6 +54,7 @@ def process_styled_content(item: MDChildNode, strict: bool = True) -> str:
         A formatted HTML string based on the item type.
     """
     _type = item.get("type")
+
     html_wrappers = {
         "text": "{value}",
         "html": "{value}",
@@ -82,9 +84,16 @@ def process_styled_content(item: MDChildNode, strict: bool = True) -> str:
 
 
 def default_to_text(node: MDChildNode):
-    return "".join(
-        process_styled_content(child) for child in node.get("children", [])
-    ) or process_styled_content(node)
+    if node["type"] == "paragraph":
+        return "".join(
+            process_styled_content(child) for child in node.get("children", [])
+        )
+    else:
+        return process_styled_content(node)
+
+    # return "".join(
+    #     process_styled_content(child) for child in node.get("children", [])
+    # ) or process_styled_content(node)
 
 
 @block("heading", "header")
@@ -173,6 +182,9 @@ class ParagraphBlock(EditorJSBlock):
                 }
             )
 
+        # deal with bold etc:
+        text = html2markdown.convert(text)
+
         return f"{text}\n\n"
 
     @classmethod
@@ -384,7 +396,7 @@ class CodeBlock(EditorJSBlock):
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         code = data.get("code", "")
-        return f"```\n" f"{code}" f"\n```\n"
+        return f"```\n{code}\n```\n"
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -406,7 +418,17 @@ class ImageBlock(EditorJSBlock):
     def to_markdown(cls, data: EditorChildData) -> str:
         url = data.get("url", "") or data.get("file", {}).get("url", "")
         caption = data.get("caption", "")
-        return f"""![{caption}]({url} "{caption}")\n\n"""
+
+        with_border = "1" if data.get("withBorder") else ""
+        with_background = "1" if data.get("withBackground") else ""
+        stretched = "1" if data.get("stretched") else ""
+
+        # always custom type so we can render as <figure> instead of markdown2's default (simple <img>)
+        return f"""<editorjs type="image" caption="{caption}" border="{with_border}" background="{with_background}" stretched="{stretched}" url="{url}" />\n\n"""
+
+    @classmethod
+    def _caption(cls, node: MDChildNode):
+        return node.get("alt") or node.get("caption") or ""
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -414,15 +436,37 @@ class ImageBlock(EditorJSBlock):
             {
                 "type": "image",
                 "data": {
-                    "caption": cls.to_text(node),
                     "file": {"url": node.get("url")},
+                    "caption": cls._caption(node),
+                    "withBorder": bool(node.get("border", False)),
+                    "stretched": bool(node.get("stretched", False)),
+                    "withBackground": bool(node.get("background", False)),
                 },
             }
         ]
 
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
-        return node.get("alt") or node.get("caption") or ""
+        caption = cls._caption(node)
+        url = node.get("url")
+
+        background = node.get("background") or ""
+        stretched = node.get("stretched") or ""
+        border = node.get("border") or ""
+
+        return f"""
+        <div class="ce-block {stretched and "ce-block--stretched"}">
+            <div class="ce-block__content">
+            <div class="cdx-block image-tool image-tool--filled {background and "image-tool--withBackground"} {stretched and "image-tool--stretched"} {border and "image-tool--withBorder"}">
+                <div class="image-tool__image">
+                    <figure>
+                        <img class="image-tool__image-picture" src="{url}" title="{caption}" alt="{caption}">
+                        <figcaption>{caption}</figcaption>
+                    </figure>
+                </div>
+            </div>
+        </div>
+        """
 
 
 @block("blockquote", "quote")
@@ -435,7 +479,7 @@ class QuoteBlock(EditorJSBlock):
         result = f"> {text}\n"
         if caption := data.get("caption", ""):
             result += f"> <cite>{caption}</cite>\n"
-        return result
+        return result + "\n"
 
     @classmethod
     def to_json(cls, node: MDChildNode) -> list[dict]:
@@ -461,12 +505,13 @@ class QuoteBlock(EditorJSBlock):
 
     @classmethod
     def to_text(cls, node: MDChildNode) -> str:
-        return default_to_text(node)
+        return "".join(
+            process_styled_content(child) for child in node.get("children", [])
+        )
 
 
 @block("raw", "html")
 class RawBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         text = data.get("html", "")
@@ -489,7 +534,6 @@ class RawBlock(EditorJSBlock):
 
 @block("table")
 class TableBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         """
@@ -608,7 +652,6 @@ class LinkBlock(EditorJSBlock):
 
 @block("attaches")
 class AttachmentBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         title = data.get("title", "")
@@ -673,7 +716,7 @@ class AttachmentBlock(EditorJSBlock):
                 </div>
                 {file_size}
             </div>
-            <a class="cdx-attaches__download-button" href="{node.get('file', '')}" target="_blank" rel="nofollow noindex noreferrer" title="{node.get('name', '')}">
+            <a class="cdx-attaches__download-button" href="{node.get("file", "")}" target="_blank" rel="nofollow noindex noreferrer" title="{node.get("name", "")}">
                 <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24"><path stroke="currentColor" stroke-linecap="round" stroke-width="2" d="M7 10L11.8586 14.8586C11.9367 14.9367 12.0633 14.9367 12.1414 14.8586L17 10"></path></svg>
             </a>
         </div>
@@ -725,7 +768,6 @@ class AlignmentBlock(EditorJSBlock):
 
 @block("embed")
 class EmbedBlock(EditorJSBlock):
-
     @classmethod
     def to_markdown(cls, data: EditorChildData) -> str:
         service = data.get("service", "")

{edwh_editorjs-2.3.2 → edwh_editorjs-2.5.0}/editorjs/core.py

@@ -1,11 +1,13 @@
 import json
 import typing as t
+import warnings
 
 import markdown2
 import mdast
 from typing_extensions import Self
 
 from .blocks import BLOCKS
+from .exceptions import TODO
 from .helpers import unix_timestamp
 from .types import MDRootNode
 
@@ -41,13 +43,26 @@ class EditorJS:
         for child in blocks:
             _type = child["type"]
             if not (block := BLOCKS.get(_type)):
-                raise TypeError(f"from_json: Unsupported block type `{_type}`")
-
-            data = child.get("data", {})
-            # forward any 'tunes' via data:
-            data["tunes"] = data.get("tunes") or child.get("tunes") or {}
-
-            markdown_items.append(block.to_markdown(data))
+                warnings.warn(
+                    f"from_json: Unsupported block type `{_type}`",
+                    category=RuntimeWarning,
+                )
+                continue
+
+            try:
+                data = child.get("data", {})
+                # forward any 'tunes' via data:
+                data["tunes"] = data.get("tunes") or child.get("tunes") or {}
+
+                markdown_items.append(block.to_markdown(data))
+            except Exception as e:
+                warnings.warn(
+                    "from_json: Oh oh, unexpected block failure!",
+                    category=RuntimeWarning,
+                    source=e,
+                )
+                # if isinstance(e, TODO):
+                #     raise e
 
         markdown = "".join(markdown_items)
         return cls.from_markdown(markdown)
@@ -76,9 +91,22 @@ class EditorJS:
         for child in self._mdast["children"]:
             _type = child["type"]
             if not (block := BLOCKS.get(_type)):
-                raise TypeError(f"to_json: Unsupported block type `{_type}`")
-
-            blocks.extend(block.to_json(child))
+                warnings.warn(
+                    f"to_json: Unsupported block type `{_type}`",
+                    category=RuntimeWarning,
+                )
+                continue
+
+            try:
+                blocks.extend(block.to_json(child))
+            except Exception as e:
+                warnings.warn(
+                    "to_json: Oh oh, unexpected block failure!",
+                    category=RuntimeWarning,
+                    source=e,
+                )
+                # if isinstance(e, TODO):
+                #     raise e
 
         data = {"time": unix_timestamp(), "blocks": blocks, "version": EDITORJS_VERSION}
 
@@ -107,7 +135,6 @@ class EditorJS:
         Export HTML string
         """
         md = self.to_markdown()
-        # todo: deal with custom elements like linktool, attaches
         return self._md.convert(md)
 
     def __repr__(self):

{edwh_editorjs-2.3.2 → edwh_editorjs-2.5.0}/pyproject.toml

@@ -27,8 +27,9 @@ requires-python = ">=3.10"
 
 dependencies = [
     # "bleach",
-    "mdast",
-    "markdown2",
+    "mdast", # markdown -> ast
+    "markdown2",  # markdown -> html
+    "html2markdown", # html -> markdown
     "humanize",
 ]
 

{edwh_editorjs-2.3.2 → edwh_editorjs-2.5.0}/tests/test_core.py

@@ -185,7 +185,8 @@ asdfsdajgdsjaklgkjds
 
 
 def test_code():
-    e = EditorJS.from_markdown(textwrap.dedent("""
+    e = EditorJS.from_markdown(
+        textwrap.dedent("""
     Read code:
     
     ```
@@ -193,7 +194,8 @@ def test_code():
     ```
     
     End of code
-    """))
+    """)
+    )
 
     blocks = json.loads(e.to_json())
 
@@ -246,3 +248,48 @@ def test_embed():
     print(e.to_markdown())
     print(e.to_html())
     print(e.to_json())
+
+
+def test_image_options():
+    json_blocks = r"""{"time":1733155142016,"blocks":[{"id":"e7_WBThzLQ","type":"image","data":{"caption":"border","withBorder":true,"withBackground":false,"stretched":false,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/5.jpg?hash=b39755c8a568cbf45d329e3a3128fb43065b1d1b","name":"kat.jpg","title":"kat","extension":"jpg","size":3682051}}},{"id":"B5qVcjqBuB","type":"image","data":{"caption":"stretch","withBorder":false,"withBackground":false,"stretched":true,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/6.jpg?hash=b39755c8a568cbf45d329e3a3128fb43065b1d1b","name":"kat.jpg","title":"kat","extension":"jpg","size":3682051}}},{"id":"ft32yP2_cv","type":"image","data":{"caption":"background","withBorder":false,"withBackground":true,"stretched":false,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/7.jpg?hash=b39755c8a568cbf45d329e3a3128fb43065b1d1b","name":"kat.jpg","title":"kat","extension":"jpg","size":3682051}}}],"version":"2.30.7"}"""
+
+    e = EditorJS.from_json(json_blocks)
+
+    print(e.to_markdown())
+    print(e.to_html())
+    print(e.to_json())
+
+
+def test_figcaption():
+    js = """{"time":1742471258492,"blocks":[{"id":"ZoA3rbc05C","type":"image","data":{"caption":"Party Time!","withBorder":false,"withBackground":false,"stretched":false,"file":{"url":"https://py4web.leiden.dockers.local/img/upload/23.png?hash=979795a433fc15cb94eccb3159f1f1e4054b1664"}}}],"version":"2.30.7"}"""
+    e = EditorJS.from_json(js)
+
+    html = e.to_html()
+
+    assert "figcaption" in html
+
+
+def test_bold():
+    js = """{"time":1742475802066,"blocks":[{"id":"v_Kc51dnJH","type":"paragraph","data":{"text":"Deze tekst is <b>half bold</b> en half niet"},"tunes":{"alignmentTune":{"alignment":"left"}}},{"id":"q_fkuEFcY5","type":"paragraph","data":{"text":"<b>Deze tekst is heel bold</b>"},"tunes":{"alignmentTune":{"alignment":"left"}}}],"version":"2.30.7"}"""
+
+    e = EditorJS.from_json(js)
+
+    print(
+        e._mdast,
+        e.to_json(),
+        e.to_html(),
+        e.to_markdown(),
+    )
+
+
+def test_quotes():
+    js = """{"time":1742477286420,"blocks":[{"id":"PpmEaxeSkq","type":"quote","data":{"text":"To baldly go where no bald man has ever gone before","caption":"a bald guy","alignment":"left"}},{"id":"26ERFQ6U3V","type":"quote","data":{"text":"Einstein was een sukkel","caption":"Einstein's ex vrouw","alignment":"left"}},{"id":"RB8AdaCd86","type":"quote","data":{"text":"Asdf","caption":"fsda-man","alignment":"left"}},{"id":"BCSus2rhUr","type":"paragraph","data":{"text":"groetjes"},"tunes":{"alignmentTune":{"alignment":"left"}}}],"version":"2.30.7"}"""
+
+    e = EditorJS.from_json(js)
+
+    print(
+        e._mdast,
+        e.to_json(),
+        e.to_html(),
+        e.to_markdown(),
+    )

edwh_editorjs-2.3.2/.github/workflows/build_documentation.yml

@@ -1,36 +0,0 @@
-name: Build documentation
-
-on:
-  workflow_dispatch:
-  release:
-    types: [published]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.10']
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install pdoc
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-      - name: Build docs
-        run: |
-          chmod +x ./scripts/build_documentation.sh
-          bash ./scripts/build_documentation.sh
-      - name: Deploy
-        uses: JamesIves/github-pages-deploy-action@4.1.4
-        with:
-          branch: documentation
-          folder: ./documentation

edwh_editorjs-2.3.2/.github/workflows/publish_to_pypi.yml

@@ -1,40 +0,0 @@
-name: Upload Python Package to PyPI
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.10']
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    
-    - name: Test with pyTest
-      run: |
-        python -m pytest -v
-
-    - name: Build package
-      run: |
-        bash ./scripts/compile_for_pypi.sh
-
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}

edwh_editorjs-2.3.2/.github/workflows/pytest.yml

@@ -1,30 +0,0 @@
-name: Test with pyTest
-
-on: [workflow_dispatch, push, pull_request]
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.10']
-      fail-fast: false
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-        cache: 'pip'
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install pytest
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    
-    - name: Test with pyTest
-      run: |
-        python -m pytest -v

edwh_editorjs-2.3.2/editorjs/__about__.py

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

edwh_editorjs-2.3.2/htmlcov/.gitignore

@@ -1,2 +0,0 @@
-# Created by coverage.py
-*