markdown-to-confluence 0.3.3__py3-none-any.whl → 0.3.5__py3-none-any.whl

md2conf/scanner.py

@@ -0,0 +1,117 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2025, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
+import re
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any, Optional
+
+import yaml
+
+
+def extract_value(pattern: str, text: str) -> tuple[Optional[str], str]:
+    values: list[str] = []
+
+    def _repl_func(matchobj: re.Match) -> str:
+        values.append(matchobj.group(1))
+        return ""
+
+    text = re.sub(pattern, _repl_func, text, count=1, flags=re.ASCII)
+    value = values[0] if values else None
+    return value, text
+
+
+def extract_frontmatter_block(text: str) -> tuple[Optional[str], str]:
+    "Extracts the front-matter from a Markdown document as a blob of unparsed text."
+
+    return extract_value(r"(?ms)\A---$(.+?)^---$", text)
+
+
+def extract_frontmatter_properties(text: str) -> tuple[Optional[dict[str, Any]], str]:
+    "Extracts the front-matter from a Markdown document as a dictionary."
+
+    block, text = extract_frontmatter_block(text)
+
+    properties: Optional[dict[str, Any]] = None
+    if block is not None:
+        data = yaml.safe_load(block)
+        if isinstance(data, dict):
+            properties = data
+
+    return properties, text
+
+
+def get_string(properties: dict[str, Any], key: str) -> Optional[str]:
+    value = properties.get(key)
+    if value is None:
+        return None
+    elif not isinstance(value, str):
+        raise ValueError(
+            f"expected dictionary value type of `str` for key `{key}`; got value of type `{type(value).__name__}`"
+        )
+    else:
+        return value
+
+
+@dataclass
+class ScannedDocument:
+    """
+    An object that holds properties extracted from a Markdown document, including remaining source text.
+
+    :param page_id: Confluence page ID.
+    :param space_key: Confluence space key.
+    :param generated_by: Text identifying the tool that generated the document.
+    :param title: The title extracted from front-matter.
+    :param text: Text that remains after front-matter and inline properties have been extracted.
+    """
+
+    page_id: Optional[str]
+    space_key: Optional[str]
+    generated_by: Optional[str]
+    title: Optional[str]
+    text: str
+
+
+class Scanner:
+    def read(self, absolute_path: Path) -> ScannedDocument:
+        """
+        Extracts essential properties from a Markdown document.
+        """
+
+        # parse file
+        with open(absolute_path, "r", encoding="utf-8") as f:
+            text = f.read()
+
+        # extract Confluence page ID
+        page_id, text = extract_value(r"<!--\s+confluence-page-id:\s*(\d+)\s+-->", text)
+
+        # extract Confluence space key
+        space_key, text = extract_value(
+            r"<!--\s+confluence-space-key:\s*(\S+)\s+-->", text
+        )
+
+        # extract 'generated-by' tag text
+        generated_by, text = extract_value(r"<!--\s+generated-by:\s*(.*)\s+-->", text)
+
+        title: Optional[str] = None
+
+        # extract front-matter
+        properties, text = extract_frontmatter_properties(text)
+        if properties is not None:
+            page_id = page_id or get_string(properties, "confluence-page-id")
+            space_key = space_key or get_string(properties, "confluence-space-key")
+            generated_by = generated_by or get_string(properties, "generated-by")
+            title = get_string(properties, "title")
+
+        return ScannedDocument(
+            page_id=page_id,
+            space_key=space_key,
+            generated_by=generated_by,
+            title=title,
+            text=text,
+        )

markdown_to_confluence-0.3.3.dist-info/RECORD

@@ -1,20 +0,0 @@
-markdown_to_confluence-0.3.3.dist-info/licenses/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
-md2conf/__init__.py,sha256=NHoSu8tHMVLytWmla4BA_Uzkl-04rV_O8YkkFxUkT_E,402
-md2conf/__main__.py,sha256=aTRiXcvoIYMkwCGejL6MUriHXBo3qVP2Acr2I-XzMyg,7947
-md2conf/api.py,sha256=S5IB7j48wE9MHSj1jodHYmTE6scSXb80faULW6-5RjU,20376
-md2conf/application.py,sha256=FkJ9zYBLwYcCRkd_WiX6JI6nlw4QMETmrOXHeSzCwCE,9735
-md2conf/converter.py,sha256=B4Z8afTmhea6nSXhzDVxN55GfMvlY34tGqCLspQ_p5g,38983
-md2conf/emoji.py,sha256=48QJtOD0F3Be1laYLvAOwe0GxrJS-vcfjtCdiBsNcAc,1960
-md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
-md2conf/matcher.py,sha256=FgMFPvGiOqGezCs8OyerfsVo-iIHFoI6LRMzdcjM5UY,3693
-md2conf/mermaid.py,sha256=un_KHBDpG5Zad_QD3HN1uBwUxp4I-HVJYhNKbH7KwcA,2312
-md2conf/processor.py,sha256=9jPswgPewh2glLSHdgxyXesGxkcxPVa_h7oUhM9EsA4,4740
-md2conf/properties.py,sha256=TOCXLdTfYkKjRwZaMgvXw0mNCI4opEUwpBXro2Kv2B4,2467
-md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
-md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-markdown_to_confluence-0.3.3.dist-info/METADATA,sha256=SiOfBvA3jMCn3Hjd_Let9R-DqcMuPG48xP-1x2pg_JI,16495
-markdown_to_confluence-0.3.3.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-markdown_to_confluence-0.3.3.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.3.3.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.3.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.3.3.dist-info/RECORD,,