markdown-to-confluence 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

{markdown_to_confluence-0.3.0.dist-info → markdown_to_confluence-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: markdown-to-confluence
-Version: 0.3.0
+Version: 0.3.2
 Summary: Publish Markdown files to Confluence wiki
 Home-page: https://github.com/hunyadi/md2conf
 Author: Levente Hunyadi
@@ -30,6 +30,7 @@ Requires-Dist: pyyaml>=6.0
 Requires-Dist: types-PyYAML>=6.0
 Requires-Dist: requests>=2.32
 Requires-Dist: types-requests>=2.32
+Dynamic: license-file
 
 # Publish Markdown files to Confluence wiki
 

markdown_to_confluence-0.3.2.dist-info/RECORD

@@ -0,0 +1,20 @@
+markdown_to_confluence-0.3.2.dist-info/licenses/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
+md2conf/__init__.py,sha256=IyztAgNkEXTxDlsTrxZOAkeNIzLSSzjNV0ZHg2SvDDE,402
+md2conf/__main__.py,sha256=ypjV_5mE0smlIRBFrpikgzXq18as2hY43HJxMLpzGp4,7145
+md2conf/api.py,sha256=-bneMbfpspfat4J63Z7bY0kdlW8yJguRRNbx6CaOkGY,20101
+md2conf/application.py,sha256=5K-nCPHJZfIahjubrLtXTwI-zsTiD140fdYXDnh3GSk,9161
+md2conf/converter.py,sha256=MoGbXqh5rE4qkdxxY8RHcnoZ5mz0aEuFz9nmUnt0WdM,36397
+md2conf/emoji.py,sha256=IZeguWqcboeOyJkGLTVONDMO4ZXfYXPgfkp56PTI-hE,1924
+md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
+md2conf/matcher.py,sha256=FgMFPvGiOqGezCs8OyerfsVo-iIHFoI6LRMzdcjM5UY,3693
+md2conf/mermaid.py,sha256=Alzkv0BY-lju4ojtBdW2qtCLZ59MO9kaS2RpQO6Kyfk,2304
+md2conf/processor.py,sha256=G-MIh1jGq9jjgogHnlnRUSrNgiV6_xO6Fy7ct9alqgM,4769
+md2conf/properties.py,sha256=WaVVOYSck7drVQfcBJmBMa7Mb0KVOZl9UZHvLS1Du8U,1892
+md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
+md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+markdown_to_confluence-0.3.2.dist-info/METADATA,sha256=2exvsuRCcD3L9CN7fl0gqki1gsqQgHDxGyjnKhDeYmw,14958
+markdown_to_confluence-0.3.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+markdown_to_confluence-0.3.2.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
+markdown_to_confluence-0.3.2.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
+markdown_to_confluence-0.3.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+markdown_to_confluence-0.3.2.dist-info/RECORD,,

{markdown_to_confluence-0.3.0.dist-info → markdown_to_confluence-0.3.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

md2conf/__init__.py

@@ -5,7 +5,7 @@ Parses Markdown files, converts Markdown content into the Confluence Storage For
 Confluence API endpoints to upload images and content.
 """
 
-__version__ = "0.3.0"
+__version__ = "0.3.2"
 __author__ = "Levente Hunyadi"
 __copyright__ = "Copyright 2022-2025, Levente Hunyadi"
 __license__ = "MIT"

md2conf/__main__.py

@@ -38,6 +38,7 @@ class Arguments(argparse.Namespace):
     ignore_invalid_url: bool
     heading_anchors: bool
     root_page: Optional[str]
+    keep_hierarchy: bool
     generated_by: Optional[str]
     render_mermaid: bool
     diagram_output_format: Literal["png", "svg"]
@@ -109,6 +110,12 @@ def main() -> None:
         dest="root_page",
         help="Root Confluence page to create new pages. If omitted, will raise exception when creating new pages.",
     )
+    parser.add_argument(
+        "--keep-hierarchy",
+        action="store_true",
+        default=False,
+        help="Maintain source directory structure when exporting to Confluence.",
+    )
     parser.add_argument(
         "--generated-by",
         default="This page has been generated with a tool.",
@@ -189,6 +196,7 @@ def main() -> None:
         ignore_invalid_url=args.ignore_invalid_url,
         generated_by=args.generated_by,
         root_page_id=args.root_page,
+        keep_hierarchy=args.keep_hierarchy,
         render_mermaid=args.render_mermaid,
         diagram_output_format=args.diagram_output_format,
         webui_links=args.webui_links,

md2conf/api.py

@@ -22,7 +22,6 @@ import requests
 
 from .converter import ParseError, sanitize_confluence
 from .properties import ConfluenceError, ConfluenceProperties
-from .util import removeprefix
 
 # a JSON type with possible `null` values
 JsonType = Union[
@@ -41,6 +40,17 @@ class ConfluenceVersion(enum.Enum):
     VERSION_2 = "api/v2"
 
 
+class ConfluencePageParentContentType(enum.Enum):
+    """
+    Content types that can be a parent to a Confluence page
+    """
+    PAGE = "page"
+    WHITEBOARD = "whiteboard"
+    DATABASE = "database"
+    EMBED = "embed"
+    FOLDER = "folder"
+
+
 def build_url(base_url: str, query: Optional[dict[str, str]] = None) -> str:
     "Builds a URL with scheme, host, port, path and query string parameters."
 
@@ -72,6 +82,8 @@ class ConfluenceAttachment:
 class ConfluencePage:
     id: str
     space_id: str
+    parent_id: str
+    parent_type: ConfluencePageParentContentType
     title: str
     version: int
     content: str
@@ -119,13 +131,17 @@ class ConfluenceSession:
     session: requests.Session
     domain: str
     base_path: str
-    space_key: str
+    space_key: Optional[str]
 
     _space_id_to_key: dict[str, str]
     _space_key_to_id: dict[str, str]
 
     def __init__(
-        self, session: requests.Session, domain: str, base_path: str, space_key: str
+        self,
+        session: requests.Session,
+        domain: str,
+        base_path: str,
+        space_key: Optional[str],
     ) -> None:
         self.session = session
         self.domain = domain
@@ -168,6 +184,10 @@ class ConfluenceSession:
         url = self._build_url(version, path, query)
         response = self.session.get(url)
         response.raise_for_status()
+        if len(response.text) > 240:
+            LOGGER.debug("Received HTTP payload (truncated):\n%.240s...", response.text)
+        else:
+            LOGGER.debug("Received HTTP payload:\n%s", response.text)
         return response.json()
 
     def _save(self, version: ConfluenceVersion, path: str, data: dict) -> None:
@@ -187,7 +207,7 @@ class ConfluenceSession:
             payload = self._invoke(
                 ConfluenceVersion.VERSION_2,
                 "/spaces",
-                {"ids": id, "type": "global", "status": "current"},
+                {"ids": id, "status": "current"},
             )
             payload = typing.cast(dict[str, JsonType], payload)
             results = typing.cast(list[JsonType], payload["results"])
@@ -209,7 +229,7 @@ class ConfluenceSession:
             payload = self._invoke(
                 ConfluenceVersion.VERSION_2,
                 "/spaces",
-                {"keys": key, "type": "global", "status": "current"},
+                {"keys": key, "status": "current"},
             )
             payload = typing.cast(dict[str, JsonType], payload)
             results = typing.cast(list[JsonType], payload["results"])
@@ -252,10 +272,8 @@ class ConfluenceSession:
         raw_data: Optional[bytes] = None,
         content_type: Optional[str] = None,
         comment: Optional[str] = None,
-        space_key: Optional[str] = None,
         force: bool = False,
     ) -> None:
-
         if attachment_path is None and raw_data is None:
             raise ConfluenceError("required: `attachment_path` or `raw_data`")
 
@@ -286,7 +304,7 @@ class ConfluenceSession:
             else:
                 raise NotImplementedError("never occurs")
 
-            id = removeprefix(attachment.id, "att")
+            id = attachment.id.removeprefix("att")
             path = f"/content/{page_id}/child/attachment/{id}/data"
 
         except ConfluenceError:
@@ -345,27 +363,18 @@ class ConfluenceSession:
         version = result["version"]["number"] + 1
 
         # ensure path component is retained in attachment name
-        self._update_attachment(
-            page_id, attachment_id, version, attachment_name, space_key=space_key
-        )
+        self._update_attachment(page_id, attachment_id, version, attachment_name)
 
     def _update_attachment(
-        self,
-        page_id: str,
-        attachment_id: str,
-        version: int,
-        attachment_title: str,
-        *,
-        space_key: Optional[str] = None,
+        self, page_id: str, attachment_id: str, version: int, attachment_title: str
     ) -> None:
-        id = removeprefix(attachment_id, "att")
+        id = attachment_id.removeprefix("att")
         path = f"/content/{page_id}/child/attachment/{id}"
         data = {
             "id": attachment_id,
             "type": "attachment",
             "status": "current",
             "title": attachment_title,
-            "space": {"key": space_key or self.space_key},
             "version": {"minorEdit": True, "number": version},
         }
 
@@ -389,9 +398,12 @@ class ConfluenceSession:
         LOGGER.info("Looking up page with title: %s", title)
         path = "/pages"
         query = {
-            "space-id": self.space_key_to_id(space_key or self.space_key),
             "title": title,
         }
+        coalesced_space_key = space_key or self.space_key
+        if coalesced_space_key is not None:
+            query["space-id"] = self.space_key_to_id(coalesced_space_key)
+
         payload = self._invoke(ConfluenceVersion.VERSION_2, path, query)
         payload = typing.cast(dict[str, JsonType], payload)
 
@@ -422,6 +434,8 @@ class ConfluenceSession:
         return ConfluencePage(
             id=page_id,
             space_id=typing.cast(str, data["spaceId"]),
+            parent_id=typing.cast(str, data["parentId"]),
+            parent_type=ConfluencePageParentContentType(typing.cast(str, data["parentType"])),
             title=typing.cast(str, data["title"]),
             version=typing.cast(int, version["number"]),
             content=typing.cast(str, storage["value"]),
@@ -432,7 +446,6 @@ class ConfluenceSession:
         Retrieve a Confluence wiki page version.
 
         :param page_id: The Confluence page ID.
-        :param space_key: The Confluence space key (unless the default space is to be used).
         :returns: Confluence page version.
         """
 
@@ -454,7 +467,6 @@ class ConfluenceSession:
 
         :param page_id: The Confluence page ID.
         :param new_content: Confluence Storage Format XHTML.
-        :param space_key: The Confluence space key (unless the default space is to be used).
         :param title: New title to assign to the page. Needs to be unique within a space.
         """
 
@@ -493,9 +505,15 @@ class ConfluenceSession:
         Create a new page via Confluence API.
         """
 
+        coalesced_space_key = space_key or self.space_key
+        if coalesced_space_key is None:
+            raise ConfluenceError(
+                "Confluence space key required for creating a new page"
+            )
+
         path = "/pages/"
         query = {
-            "spaceId": self.space_key_to_id(space_key or self.space_key),
+            "spaceId": self.space_key_to_id(coalesced_space_key),
             "status": "current",
             "title": title,
             "parentId": parent_page_id,
@@ -520,6 +538,8 @@ class ConfluenceSession:
         return ConfluencePage(
             id=typing.cast(str, data["id"]),
             space_id=typing.cast(str, data["spaceId"]),
+            parent_id=typing.cast(str, data["parentId"]),
+            parent_type=ConfluencePageParentContentType(typing.cast(str, data["parentType"])),
             title=typing.cast(str, data["title"]),
             version=typing.cast(int, version["number"]),
             content=typing.cast(str, storage["value"]),
@@ -553,10 +573,10 @@ class ConfluenceSession:
         self, title: str, *, space_key: Optional[str] = None
     ) -> Optional[str]:
         path = "/pages"
-        query = {
-            "title": title,
-            "space-id": self.space_key_to_id(space_key or self.space_key),
-        }
+        coalesced_space_key = space_key or self.space_key
+        query = {"title": title}
+        if coalesced_space_key is not None:
+            query["space-id"] = self.space_key_to_id(coalesced_space_key)
 
         LOGGER.info("Checking if page exists with title: %s", title)
 

md2conf/application.py

@@ -131,6 +131,15 @@ class Application:
             parent_doc = Path(local_dir) / "index.md"
         elif (Path(local_dir) / "README.md") in files:
             parent_doc = Path(local_dir) / "README.md"
+        elif (Path(local_dir) / f"{local_dir.name}.md") in files:
+            parent_doc = Path(local_dir) / f"{local_dir.name}.md"
+
+        if parent_doc is None and self.options.keep_hierarchy:
+            parent_doc = Path(local_dir) / "index.md"
+
+            # create a blank page in Confluence for the directory entry
+            with open(parent_doc, "w"):
+                pass
 
         if parent_doc is not None:
             files.remove(parent_doc)

md2conf/converter.py

@@ -13,7 +13,6 @@ import importlib.resources as resources
 import logging
 import os.path
 import re
-import sys
 import uuid
 import xml.etree.ElementTree
 from dataclasses import dataclass
@@ -129,7 +128,7 @@ def _elements_from_strings(dtd_path: Path, items: list[str]) -> ET._Element:
 
     data = [
         '<?xml version="1.0"?>',
-        f'<!DOCTYPE ac:confluence PUBLIC "-//Atlassian//Confluence 4 Page//EN" "{dtd_path}">'
+        f'<!DOCTYPE ac:confluence PUBLIC "-//Atlassian//Confluence 4 Page//EN" "{dtd_path.as_posix()}">'
         f"<root{ns_attr_list}>",
     ]
     data.extend(items)
@@ -144,13 +143,9 @@ def _elements_from_strings(dtd_path: Path, items: list[str]) -> ET._Element:
 def elements_from_strings(items: list[str]) -> ET._Element:
     "Creates a fragment of several XML nodes from their string representation wrapped in a root element."
 
-    if sys.version_info >= (3, 9):
-        resource_path = resources.files(__package__).joinpath("entities.dtd")
-        with resources.as_file(resource_path) as dtd_path:
-            return _elements_from_strings(dtd_path, items)
-    else:
-        with resources.path(__package__, "entities.dtd") as dtd_path:
-            return _elements_from_strings(dtd_path, items)
+    resource_path = resources.files(__package__).joinpath("entities.dtd")
+    with resources.as_file(resource_path) as dtd_path:
+        return _elements_from_strings(dtd_path, items)
 
 
 def elements_from_string(content: str) -> ET._Element:
@@ -244,7 +239,7 @@ class ConfluencePageMetadata:
     domain: str
     base_path: str
     page_id: str
-    space_key: str
+    space_key: Optional[str]
     title: str
 
 
@@ -976,6 +971,7 @@ class ConfluenceDocumentOptions:
         conversion rules for the identifier.
     :param generated_by: Text to use as the generated-by prompt (or `None` to omit a prompt).
     :param root_page_id: Confluence page to assume root page role for publishing a directory of Markdown files.
+    :param keep_hierarchy: Whether to maintain source directory structure when exporting to Confluence.
     :param render_mermaid: Whether to pre-render Mermaid diagrams into PNG/SVG images.
     :param diagram_output_format: Target image format for diagrams.
     :param webui_links: When true, convert relative URLs to Confluence Web UI links.
@@ -985,6 +981,7 @@ class ConfluenceDocumentOptions:
     heading_anchors: bool = False
     generated_by: Optional[str] = "This page has been generated with a tool."
     root_page_id: Optional[str] = None
+    keep_hierarchy: bool = False
     render_mermaid: bool = False
     diagram_output_format: Literal["png", "svg"] = "png"
     webui_links: bool = False
@@ -1132,10 +1129,6 @@ def _content_to_string(dtd_path: Path, content: str) -> str:
 def content_to_string(content: str) -> str:
     "Converts a Confluence Storage Format document returned by the API into a readable XML document."
 
-    if sys.version_info >= (3, 9):
-        resource_path = resources.files(__package__).joinpath("entities.dtd")
-        with resources.as_file(resource_path) as dtd_path:
-            return _content_to_string(dtd_path, content)
-    else:
-        with resources.path(__package__, "entities.dtd") as dtd_path:
-            return _content_to_string(dtd_path, content)
+    resource_path = resources.files(__package__).joinpath("entities.dtd")
+    with resources.as_file(resource_path) as dtd_path:
+        return _content_to_string(dtd_path, content)

md2conf/mermaid.py

@@ -29,7 +29,11 @@ def get_mmdc() -> str:
     "Path to the Mermaid diagram converter."
 
     if is_docker():
-        return "/home/md2conf/node_modules/.bin/mmdc"
+        full_path = "/home/md2conf/node_modules/.bin/mmdc"
+        if os.path.exists(full_path):
+            return full_path
+        else:
+            return "mmdc"
     elif os.name == "nt":
         return "mmdc.cmd"
     else:

md2conf/properties.py

@@ -17,7 +17,7 @@ class ConfluenceError(RuntimeError):
 class ConfluenceProperties:
     domain: str
     base_path: str
-    space_key: str
+    space_key: Optional[str]
     user_name: Optional[str]
     api_key: str
     headers: Optional[dict[str, str]]
@@ -43,8 +43,6 @@ class ConfluenceProperties:
             opt_base_path = "/wiki/"
         if not opt_api_key:
             raise ConfluenceError("Confluence API key not specified")
-        if not opt_space_key:
-            raise ConfluenceError("Confluence space key not specified")
 
         if opt_domain.startswith(("http://", "https://")) or opt_domain.endswith("/"):
             raise ConfluenceError(

markdown_to_confluence-0.3.0.dist-info/RECORD

@@ -1,21 +0,0 @@
-md2conf/__init__.py,sha256=Lveuwj776s0e_lokulqzAtv64eStsiMROB96DimCLd0,402
-md2conf/__main__.py,sha256=Sga_W_b5E1YokJcBAXcmZVnYk-us8A0kkhfkmdHogsg,6883
-md2conf/api.py,sha256=KIZNwdsMGXYy9i4FHSe0XbbCjjVJzTTlnryGesxM-GI,19312
-md2conf/application.py,sha256=Udp79iB0bGc7sPmE3jD7PSK35yedS_XBhfTEVap91-o,8777
-md2conf/converter.py,sha256=BlS51hjiJd0lgrh5wJkun1_FZ9kAtmInKjEYhr5YOLA,36620
-md2conf/emoji.py,sha256=IZeguWqcboeOyJkGLTVONDMO4ZXfYXPgfkp56PTI-hE,1924
-md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
-md2conf/matcher.py,sha256=FgMFPvGiOqGezCs8OyerfsVo-iIHFoI6LRMzdcjM5UY,3693
-md2conf/mermaid.py,sha256=82NGv6x_LNrN3c-VPx368KCBO87_Sv8-uz2ue40DzKg,2192
-md2conf/processor.py,sha256=G-MIh1jGq9jjgogHnlnRUSrNgiV6_xO6Fy7ct9alqgM,4769
-md2conf/properties.py,sha256=HqFveB-Wgg29e60tARHSk21l8b-SCk953eb_Mw-nI80,1984
-md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
-md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-md2conf/util.py,sha256=Ct7T21oI2AUs6hIZVNljPhq5HbNscjnFXMpVCzRlRHw,743
-markdown_to_confluence-0.3.0.dist-info/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
-markdown_to_confluence-0.3.0.dist-info/METADATA,sha256=oAWMGSnPXtLZZyDiwNdbb4QWwEP0uXPxzKiBqY9mfT0,14936
-markdown_to_confluence-0.3.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-markdown_to_confluence-0.3.0.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.3.0.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.3.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.3.0.dist-info/RECORD,,

md2conf/util.py

@@ -1,27 +0,0 @@
-"""
-Publish Markdown files to Confluence wiki.
-
-Copyright 2022-2025, Levente Hunyadi
-
-:see: https://github.com/hunyadi/md2conf
-"""
-
-import sys
-
-if sys.version_info >= (3, 9):
-
-    def removeprefix(string: str, prefix: str) -> str:
-        "If the string starts with the prefix, return the string without the prefix; otherwise, return the original string."
-
-        return string.removeprefix(prefix)
-
-else:
-
-    def removeprefix(string: str, prefix: str) -> str:
-        "If the string starts with the prefix, return the string without the prefix; otherwise, return the original string."
-
-        if string.startswith(prefix):
-            prefix_len = len(prefix)
-            return string[prefix_len:]
-        else:
-            return string