markdown-to-confluence 0.3.4__py3-none-any.whl → 0.4.0__py3-none-any.whl

md2conf/scanner.py

@@ -0,0 +1,149 @@
+"""
+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, TypeVar
+
+import yaml
+from strong_typing.core import JsonType
+from strong_typing.serialization import DeserializerOptions, json_to_object
+
+T = TypeVar("T")
+
+
+def _json_to_object(
+    typ: type[T],
+    data: JsonType,
+) -> T:
+    return json_to_object(typ, data, options=DeserializerOptions(skip_unassigned=True))
+
+
+def extract_value(pattern: str, text: str) -> tuple[Optional[str], str]:
+    values: list[str] = []
+
+    def _repl_func(matchobj: re.Match[str]) -> 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
+
+
+@dataclass
+class DocumentProperties:
+    """
+    An object that holds properties extracted from the front-matter of a Markdown document.
+
+    :param page_id: Confluence page ID.
+    :param space_key: Confluence space key.
+    :param confluence_page_id: Confluence page ID. (Alternative name for JSON de-serialization.)
+    :param confluence_space_key: Confluence space key. (Alternative name for JSON de-serialization.)
+    :param generated_by: Text identifying the tool that generated the document.
+    :param title: The title extracted from front-matter.
+    :param tags: A list of tags (content labels) extracted from front-matter.
+    """
+
+    page_id: Optional[str]
+    space_key: Optional[str]
+    confluence_page_id: Optional[str]
+    confluence_space_key: Optional[str]
+    generated_by: Optional[str]
+    title: Optional[str]
+    tags: Optional[list[str]]
+
+
+@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 tags: A list of tags (content labels) 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]
+    tags: Optional[list[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
+        tags: Optional[list[str]] = None
+
+        # extract front-matter
+        data, text = extract_frontmatter_properties(text)
+        if data is not None:
+            p = _json_to_object(DocumentProperties, data)
+            page_id = page_id or p.confluence_page_id or p.page_id
+            space_key = space_key or p.confluence_space_key or p.space_key
+            generated_by = generated_by or p.generated_by
+            title = p.title
+            tags = p.tags
+
+        return ScannedDocument(
+            page_id=page_id,
+            space_key=space_key,
+            generated_by=generated_by,
+            title=title,
+            tags=tags,
+            text=text,
+        )

markdown_to_confluence-0.3.4.dist-info/RECORD

@@ -1,22 +0,0 @@
-markdown_to_confluence-0.3.4.dist-info/licenses/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
-md2conf/__init__.py,sha256=9gI6OYCv9-54FzxjNHLOH09H5quUDEMWq9pdbhnwoXM,402
-md2conf/__main__.py,sha256=bFcfmSnTWeuhmDm7bJ3jJabZ2S8W9biuAP6_R-Cc9As,8034
-md2conf/api.py,sha256=ZIYoBXclLbzrrQ_oFRllsTEnQIMbxqd9OD80-AC5qM0,22769
-md2conf/application.py,sha256=eIVeAGUzfdIq1uYLYpTg30UNSq-YcUIY-OgKKK3M4E4,6436
-md2conf/converter.py,sha256=2Sgq1WQd-dCtrdTVrBwhowPC8PmubMNCH1aAcRwntjs,39404
-md2conf/emoji.py,sha256=48QJtOD0F3Be1laYLvAOwe0GxrJS-vcfjtCdiBsNcAc,1960
-md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
-md2conf/local.py,sha256=AOuwyvPOXrRRPGOTDeoVYkMPJ9MI2zqRGAvHuY35wy4,3884
-md2conf/matcher.py,sha256=FgMFPvGiOqGezCs8OyerfsVo-iIHFoI6LRMzdcjM5UY,3693
-md2conf/mermaid.py,sha256=un_KHBDpG5Zad_QD3HN1uBwUxp4I-HVJYhNKbH7KwcA,2312
-md2conf/metadata.py,sha256=9BtNRsICbKzPTs63P70XekNARePdW1DtdKNJqXh2ZFM,1013
-md2conf/processor.py,sha256=Ko_3WqLK6jM-bEN7OD9Vc3g3vhSjRYawz3fG6uoUsXc,6733
-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.4.dist-info/METADATA,sha256=PUtJXudDooVfwOzVtohxweWHMjgDv5CIrDvyqiJ0tlg,17745
-markdown_to_confluence-0.3.4.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-markdown_to_confluence-0.3.4.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.3.4.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.3.4.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.3.4.dist-info/RECORD,,