markdown-to-confluence 0.2.4__py3-none-any.whl → 0.2.5__py3-none-any.whl

{markdown_to_confluence-0.2.4.dist-info → markdown_to_confluence-0.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-to-confluence
-Version: 0.2.4
+Version: 0.2.5
 Summary: Publish Markdown files to Confluence wiki
 Home-page: https://github.com/hunyadi/md2conf
 Author: Levente Hunyadi

markdown_to_confluence-0.2.5.dist-info/RECORD

@@ -0,0 +1,21 @@
+md2conf/__init__.py,sha256=0eak9lvskuCqGJnGeno6SHoCiBFAX5IQLHVBx1LV0w8,402
+md2conf/__main__.py,sha256=6iOI28W_d71tlnCMFpZwvkBmBt5-HazlZsz69gS4Oak,6894
+md2conf/api.py,sha256=EZSHbuH5O9fPyW7iLAX0Fqw8njXmvd6sEbgseP-eUUc,16498
+md2conf/application.py,sha256=hmfLiofGulN8zUw2uXuueohCkDh978sqLkoUot928qM,8796
+md2conf/converter.py,sha256=8X8tNELqwAaZYSVvczJl_ZpJL9tu2ImCBXaQBQvGgeM,34413
+md2conf/emoji.py,sha256=w9oiOIxzObAE7HTo3f6aETT1_D3t3yZwr88ynU4ENm0,1924
+md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
+md2conf/matcher.py,sha256=mYMltZOLypK4O-SJugLgicOwUMem67hiNLg_kPFoJkU,3583
+md2conf/mermaid.py,sha256=Tsibd1aOn4hRYv6emQg0hrZMPTkflIeXHVbZ7nQ5lSc,2108
+md2conf/processor.py,sha256=tUt5D4_D3uhofg2Bn23owBJmkVHj4tSll0zI95J6cdk,4243
+md2conf/properties.py,sha256=iVIc0h0XtS3Y2LCywX1C9cvmVQ0WljOMt8pl2MDMVCI,1990
+md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
+md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+md2conf/util.py,sha256=ftf60MiW7S7rW45ipWX6efP_Sv2F2qpyIDHrGA0cBiw,743
+markdown_to_confluence-0.2.5.dist-info/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
+markdown_to_confluence-0.2.5.dist-info/METADATA,sha256=E7j_aFJ7rT4SOpoUIa40G2QJL_7PjuXBA5JvdANRIdc,12764
+markdown_to_confluence-0.2.5.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+markdown_to_confluence-0.2.5.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
+markdown_to_confluence-0.2.5.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
+markdown_to_confluence-0.2.5.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+markdown_to_confluence-0.2.5.dist-info/RECORD,,

{markdown_to_confluence-0.2.4.dist-info → markdown_to_confluence-0.2.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.3.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.2.4"
+__version__ = "0.2.5"
 __author__ = "Levente Hunyadi"
 __copyright__ = "Copyright 2022-2024, Levente Hunyadi"
 __license__ = "MIT"

md2conf/__main__.py

@@ -1,3 +1,14 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Parses Markdown files, converts Markdown content into the Confluence Storage Format (XHTML), and invokes
+Confluence API endpoints to upload images and content.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import argparse
 import logging
 import os.path

md2conf/api.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import io
 import json
 import logging
@@ -491,7 +499,7 @@ class ConfluenceSession:
         page_id = self.page_exists(title)
 
         if page_id is not None:
-            LOGGER.debug("Retrieving existing page: %d", page_id)
+            LOGGER.debug("Retrieving existing page: %s", page_id)
             return self.get_page(page_id)
         else:
             LOGGER.debug("Creating new page with title: %s", title)

md2conf/application.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import logging
 import os.path
 from pathlib import Path
@@ -36,6 +44,7 @@ class Application:
     def synchronize(self, path: Path) -> None:
         "Synchronizes a single Markdown page or a directory of Markdown pages."
 
+        path = path.resolve(True)
         if path.is_dir():
             self.synchronize_directory(path)
         elif path.is_file():
@@ -46,12 +55,14 @@ class Application:
     def synchronize_page(self, page_path: Path) -> None:
         "Synchronizes a single Markdown page with Confluence."
 
+        page_path = page_path.resolve(True)
         self._synchronize_page(page_path, {})
 
     def synchronize_directory(self, local_dir: Path) -> None:
         "Synchronizes a directory of Markdown pages with Confluence."
 
-        LOGGER.info(f"Synchronizing directory: {local_dir}")
+        LOGGER.info("Synchronizing directory: %s", local_dir)
+        local_dir = local_dir.resolve(True)
 
         # Step 1: build index of all page metadata
         page_metadata: Dict[Path, ConfluencePageMetadata] = {}
@@ -61,7 +72,7 @@ class Application:
             else None
         )
         self._index_directory(local_dir, root_id, page_metadata)
-        LOGGER.info(f"indexed {len(page_metadata)} page(s)")
+        LOGGER.info("Indexed %d page(s)", len(page_metadata))
 
         # Step 2: convert each page
         for page_path in page_metadata.keys():
@@ -74,7 +85,7 @@ class Application:
     ) -> None:
         base_path = page_path.parent
 
-        LOGGER.info(f"Synchronizing page: {page_path}")
+        LOGGER.info("Synchronizing page: %s", page_path)
         document = ConfluenceDocument(page_path, self.options, page_metadata)
 
         if document.id.space_key:
@@ -91,7 +102,7 @@ class Application:
     ) -> None:
         "Indexes Markdown files in a directory recursively."
 
-        LOGGER.info(f"Indexing directory: {local_dir}")
+        LOGGER.info("Indexing directory: %s", local_dir)
 
         matcher = Matcher(MatcherOptions(source=".mdignore", extension="md"), local_dir)
 
@@ -107,22 +118,30 @@ class Application:
                 directories.append(Path(local_dir) / entry.name)
 
         # make page act as parent node in Confluence
-        parent_id: Optional[ConfluenceQualifiedID] = None
+        parent_doc: Optional[Path] = None
         if (Path(local_dir) / "index.md") in files:
-            parent_id = read_qualified_id(Path(local_dir) / "index.md")
+            parent_doc = Path(local_dir) / "index.md"
         elif (Path(local_dir) / "README.md") in files:
-            parent_id = read_qualified_id(Path(local_dir) / "README.md")
+            parent_doc = Path(local_dir) / "README.md"
 
-        if parent_id is None:
+        if parent_doc is not None:
+            files.remove(parent_doc)
+
+            metadata = self._get_or_create_page(parent_doc, root_id)
+            LOGGER.debug("Indexed parent %s with metadata: %s", parent_doc, metadata)
+            page_metadata[parent_doc] = metadata
+
+            parent_id = read_qualified_id(parent_doc) or root_id
+        else:
             parent_id = root_id
 
         for doc in files:
             metadata = self._get_or_create_page(doc, parent_id)
-            LOGGER.debug(f"indexed {doc} with metadata: {metadata}")
+            LOGGER.debug("Indexed %s with metadata: %s", doc, metadata)
             page_metadata[doc] = metadata
 
         for directory in directories:
-            self._index_directory(Path(local_dir) / directory, parent_id, page_metadata)
+            self._index_directory(directory, parent_id, page_metadata)
 
     def _get_or_create_page(
         self,
@@ -215,7 +234,7 @@ class Application:
             )
 
         content = document.xhtml()
-        LOGGER.debug(f"generated Confluence Storage Format document:\n{content}")
+        LOGGER.debug("Generated Confluence Storage Format document:\n%s", content)
         self.api.update_page(document.id.page_id, content)
 
     def _update_markdown(

md2conf/converter.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 # mypy: disable-error-code="dict-item"
 
 import hashlib
@@ -343,7 +351,7 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
         if is_absolute_url(url):
             return None
 
-        LOGGER.debug(f"found link {url} relative to {self.path}")
+        LOGGER.debug("Found link %s relative to %s", url, self.path)
         relative_url: ParseResult = urlparse(url)
 
         if (
@@ -353,7 +361,7 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
             and not relative_url.params
             and not relative_url.query
         ):
-            LOGGER.debug(f"found local URL: {url}")
+            LOGGER.debug("Found local URL: %s", url)
             if self.options.heading_anchors:
                 # <ac:link ac:anchor="anchor"><ac:link-body>...</ac:link-body></ac:link>
                 target = relative_url.fragment.lstrip("#")
@@ -398,7 +406,7 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
                 raise DocumentError(msg)
 
         LOGGER.debug(
-            f"found link to page {relative_path} with metadata: {link_metadata}"
+            "found link to page %s with metadata: %s", relative_path, link_metadata
         )
         self.links.append(url)
 
@@ -417,7 +425,7 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
         )
         transformed_url = urlunparse(components)
 
-        LOGGER.debug(f"transformed relative URL: {url} to URL: {transformed_url}")
+        LOGGER.debug("Transformed relative URL: %s to URL: %s", url, transformed_url)
         anchor.attrib["href"] = transformed_url
         return None
 

md2conf/emoji.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import pathlib
 
 import pymdownx.emoji1_db as emoji_db

md2conf/matcher.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import os.path
 from dataclasses import dataclass
 from fnmatch import fnmatch

md2conf/mermaid.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import logging
 import os
 import os.path
@@ -52,7 +60,7 @@ def render(source: str, output_format: Literal["png", "svg"] = "png") -> bytes:
     root = os.path.dirname(__file__)
     if is_docker():
         cmd.extend(["-p", os.path.join(root, "puppeteer-config.json")])
-    LOGGER.debug(f"Executing: {' '.join(cmd)}")
+    LOGGER.debug("Executing: %s", " ".join(cmd))
     try:
         proc = subprocess.Popen(
             cmd,

md2conf/processor.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import hashlib
 import logging
 import os
@@ -30,6 +38,7 @@ class Processor:
     def process(self, path: Path) -> None:
         "Processes a single Markdown file or a directory of Markdown files."
 
+        path = path.resolve(True)
         if path.is_dir():
             self.process_directory(path)
         elif path.is_file():
@@ -40,12 +49,13 @@ class Processor:
     def process_directory(self, local_dir: Path) -> None:
         "Recursively scans a directory hierarchy for Markdown files."
 
-        LOGGER.info(f"Synchronizing directory: {local_dir}")
+        LOGGER.info("Synchronizing directory: %s", local_dir)
+        local_dir = local_dir.resolve(True)
 
         # Step 1: build index of all page metadata
         page_metadata: Dict[Path, ConfluencePageMetadata] = {}
         self._index_directory(local_dir, page_metadata)
-        LOGGER.info(f"indexed {len(page_metadata)} page(s)")
+        LOGGER.info("Indexed %d page(s)", len(page_metadata))
 
         # Step 2: convert each page
         for page_path in page_metadata.keys():
@@ -56,6 +66,7 @@ class Processor:
     ) -> None:
         "Processes a single Markdown file."
 
+        path = path.resolve(True)
         document = ConfluenceDocument(path, self.options, page_metadata)
         content = document.xhtml()
         with open(path.with_suffix(".csf"), "w", encoding="utf-8") as f:
@@ -68,7 +79,7 @@ class Processor:
     ) -> None:
         "Indexes Markdown files in a directory recursively."
 
-        LOGGER.info(f"Indexing directory: {local_dir}")
+        LOGGER.info("Indexing directory: %s", local_dir)
 
         matcher = Matcher(MatcherOptions(source=".mdignore", extension="md"), local_dir)
 
@@ -85,11 +96,11 @@ class Processor:
 
         for doc in files:
             metadata = self._get_page(doc)
-            LOGGER.debug(f"indexed {doc} with metadata: {metadata}")
+            LOGGER.debug("Indexed %s with metadata: %s", doc, metadata)
             page_metadata[doc] = metadata
 
         for directory in directories:
-            self._index_directory(Path(local_dir) / directory, page_metadata)
+            self._index_directory(directory, page_metadata)
 
     def _get_page(self, absolute_path: Path) -> ConfluencePageMetadata:
         "Extracts metadata from a Markdown file."
@@ -102,7 +113,7 @@ class Processor:
             if self.options.root_page_id is not None:
                 hash = hashlib.md5(document.encode("utf-8"))
                 digest = "".join(f"{c:x}" for c in hash.digest())
-                LOGGER.info(f"Identifier '{digest}' assigned to page: {absolute_path}")
+                LOGGER.info("Identifier %s assigned to page: %s", digest, absolute_path)
                 qualified_id = ConfluenceQualifiedID(digest)
             else:
                 raise ValueError("required: page ID for local output")

md2conf/properties.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import os
 from typing import Dict, Optional
 

md2conf/util.py

@@ -1,3 +1,11 @@
+"""
+Publish Markdown files to Confluence wiki.
+
+Copyright 2022-2024, Levente Hunyadi
+
+:see: https://github.com/hunyadi/md2conf
+"""
+
 import sys
 
 if sys.version_info >= (3, 9):

markdown_to_confluence-0.2.4.dist-info/RECORD

@@ -1,21 +0,0 @@
-md2conf/__init__.py,sha256=zCKYQvETObXjgxGYFlwiftPJL64cqwfEW3PGriejyh4,402
-md2conf/__main__.py,sha256=_qUspNQmQdhpH4Myh9vXDcauPyUx_FyEzNtaW_c8ytY,6601
-md2conf/api.py,sha256=bP3Kp4PsGQrPyQMOs-MwE2Znl1ewuKNslMCv7AtXIT0,16366
-md2conf/application.py,sha256=f5O-EUTXh-SO4P57rgqfwBbbX-A8S_n7PM4HW9AsMLc,8277
-md2conf/converter.py,sha256=H9OdaLb_JXAYIa5eEwVmJN75ESWarplq2LRo30gWur4,34271
-md2conf/emoji.py,sha256=2vMZlLD4m2X6MB-Fjv_GDzEUelb_sg4UBtF463d_p90,1792
-md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
-md2conf/matcher.py,sha256=bZMX_GTXuEeKqIPDES8KqAqTBiesKfSH9rwbNFkD25A,3451
-md2conf/mermaid.py,sha256=u2pSKaLrvB3yeDciVO9mIfUT2dbVVfTALYLBaIgaJ-Y,1975
-md2conf/processor.py,sha256=bdwSEnxuvWsZd34_KcvLqigM8GHnll9fc-hf1VQ_5aI,4010
-md2conf/properties.py,sha256=2l1tW8HmnrEsXN4-Dtby2tYJQTG1MirRpM3H6ykjQ4c,1858
-md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
-md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-md2conf/util.py,sha256=mghtBv5c0vOBHi5CxjBh4LZbjQ0Cu0h_vB30RN4N8Bk,611
-markdown_to_confluence-0.2.4.dist-info/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
-markdown_to_confluence-0.2.4.dist-info/METADATA,sha256=vjvF6LP_5tQAKY9ACKkmAllQDlqjyJuSg_W7bBKct5Y,12764
-markdown_to_confluence-0.2.4.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-markdown_to_confluence-0.2.4.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.2.4.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.2.4.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.2.4.dist-info/RECORD,,