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

md2conf/properties.py

@@ -7,7 +7,7 @@ Copyright 2022-2025, Levente Hunyadi
 """
 
 import os
-from typing import Optional
+from typing import Optional, overload
 
 
 class ArgumentError(ValueError):
@@ -22,6 +22,42 @@ class ConfluenceError(RuntimeError):
     "Raised when a Confluence API call fails."
 
 
+@overload
+def _validate_domain(domain: str) -> str: ...
+
+
+@overload
+def _validate_domain(domain: Optional[str]) -> Optional[str]: ...
+
+
+def _validate_domain(domain: Optional[str]) -> Optional[str]:
+    if domain is None:
+        return None
+
+    if domain.startswith(("http://", "https://")) or domain.endswith("/"):
+        raise ArgumentError("Confluence domain looks like a URL; only host name required")
+
+    return domain
+
+
+@overload
+def _validate_base_path(base_path: str) -> str: ...
+
+
+@overload
+def _validate_base_path(base_path: Optional[str]) -> Optional[str]: ...
+
+
+def _validate_base_path(base_path: Optional[str]) -> Optional[str]:
+    if base_path is None:
+        return None
+
+    if not base_path.startswith("/") or not base_path.endswith("/"):
+        raise ArgumentError("Confluence base path must start and end with a '/'")
+
+    return base_path
+
+
 class ConfluenceSiteProperties:
     domain: str
     base_path: str
@@ -42,15 +78,8 @@ class ConfluenceSiteProperties:
         if not opt_base_path:
             opt_base_path = "/wiki/"
 
-        if opt_domain.startswith(("http://", "https://")) or opt_domain.endswith("/"):
-            raise ArgumentError(
-                "Confluence domain looks like a URL; only host name required"
-            )
-        if not opt_base_path.startswith("/") or not opt_base_path.endswith("/"):
-            raise ArgumentError("Confluence base path must start and end with a '/'")
-
-        self.domain = opt_domain
-        self.base_path = opt_base_path
+        self.domain = _validate_domain(opt_domain)
+        self.base_path = _validate_base_path(opt_base_path)
         self.space_key = opt_space_key
 
 
@@ -92,10 +121,14 @@ class ConfluenceConnectionProperties:
 
         if not opt_api_key:
             raise ArgumentError("Confluence API key not specified")
+        if not opt_api_url and not opt_domain:
+            raise ArgumentError("Confluence API URL or domain required")
+        if not opt_api_url and not opt_base_path:
+            opt_base_path = "/wiki/"
 
         self.api_url = opt_api_url
-        self.domain = opt_domain
-        self.base_path = opt_base_path
+        self.domain = _validate_domain(opt_domain)
+        self.base_path = _validate_base_path(opt_base_path)
         self.space_key = opt_space_key
         self.user_name = opt_user_name
         self.api_key = opt_api_key

md2conf/scanner.py

@@ -69,6 +69,7 @@ class DocumentProperties:
     :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 properties: A dictionary of key-value pairs extracted from front-matter to apply as page properties.
     """
 
     page_id: Optional[str]
@@ -78,6 +79,7 @@ class DocumentProperties:
     generated_by: Optional[str]
     title: Optional[str]
     tags: Optional[list[str]]
+    properties: Optional[dict[str, JsonType]]
 
 
 @dataclass
@@ -90,6 +92,7 @@ class ScannedDocument:
     :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 properties: A dictionary of key-value pairs extracted from front-matter to apply as page properties.
     :param text: Text that remains after front-matter and inline properties have been extracted.
     """
 
@@ -98,6 +101,7 @@ class ScannedDocument:
     generated_by: Optional[str]
     title: Optional[str]
     tags: Optional[list[str]]
+    properties: Optional[dict[str, JsonType]]
     text: str
 
 
@@ -112,22 +116,17 @@ class Scanner:
             text = f.read()
 
         # extract Confluence page ID
-        page_id, text = extract_value(
-            r"<!--\s+confluence[-_]page[-_]id:\s*(\d+)\s+-->", text
-        )
+        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
-        )
+        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
-        )
+        generated_by, text = extract_value(r"<!--\s+generated[-_]by:\s*(.*)\s+-->", text)
 
         title: Optional[str] = None
         tags: Optional[list[str]] = None
+        properties: Optional[dict[str, JsonType]] = None
 
         # extract front-matter
         data, text = extract_frontmatter_properties(text)
@@ -138,6 +137,7 @@ class Scanner:
             generated_by = generated_by or p.generated_by
             title = p.title
             tags = p.tags
+            properties = p.properties
 
         return ScannedDocument(
             page_id=page_id,
@@ -145,5 +145,6 @@ class Scanner:
             generated_by=generated_by,
             title=title,
             tags=tags,
+            properties=properties,
             text=text,
         )

markdown_to_confluence-0.4.0.dist-info/RECORD

@@ -1,25 +0,0 @@
-markdown_to_confluence-0.4.0.dist-info/licenses/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
-md2conf/__init__.py,sha256=wwC9K_CM_n25aE2PFfbtbHwaeTRU_l4ZfhrTJGYfRyY,402
-md2conf/__main__.py,sha256=GU_ikdNh2a3gZqOwM6GLR8qM3moeLXaNydQ052G5Pw0,8423
-md2conf/api.py,sha256=kJa4VTNjRwVydasW1YwJeRPI0OrRxiWnxh3OvusCA3o,31985
-md2conf/application.py,sha256=AMVqPQ3A_jUm9ao3M85Ew9MEyS29ar950aHtk_kp6_U,7460
-md2conf/collection.py,sha256=EAXuIFcIRBO-Giic2hdU2d4Hpj0_ZFBAWI3aKQ2fjrI,775
-md2conf/converter.py,sha256=odmoDU_0_ttm2xcC36kTA4w9AptI61lDoNAMUMLj2jg,37553
-md2conf/emoji.py,sha256=UzDrxqFo59wHmbbJmMNdn0rYFDXbZE4qirOM-_egzXc,2603
-md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
-md2conf/extra.py,sha256=Y7_cL7ff9WdhMTHK13ZKjgA19UXJgBT-zIgFv2V57M0,309
-md2conf/local.py,sha256=Uk7x5-jr56BctuUBJoUXgbz2qtES-qqMV27x9nh0280,3584
-md2conf/matcher.py,sha256=y5WEZNklTpUoJtMJlulTvfhl_v-UMU6wySJAKit91ig,4940
-md2conf/mermaid.py,sha256=ZETocFDKi_fSYyVR1pJ7fo207YYFSuT44MSYFQ8-cZ0,2562
-md2conf/metadata.py,sha256=TxgUrskqsWor_pvlQx-p86C0-0qRJ2aeQhuDcXU9Dpc,886
-md2conf/processor.py,sha256=8lRM1s0u1O9fBH2cVsGrfLshwDfjvePxSJB8SEZLcJ4,9815
-md2conf/properties.py,sha256=Z0T9VkEtnPNoRviX1SIrwUJC5cezl-Mv6wmVKxGZdX8,3205
-md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
-md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-md2conf/scanner.py,sha256=hkseFV6dWJrKKBhBt9fzKtKliOyDMDkumEVrZF3q1N4,4584
-markdown_to_confluence-0.4.0.dist-info/METADATA,sha256=qeCHbGT8sUwgi11bKYMFFi2UmFa3DyFBCZlzjftHyxs,23573
-markdown_to_confluence-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-markdown_to_confluence-0.4.0.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.4.0.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.4.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.4.0.dist-info/RECORD,,