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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-to-confluence
-Version: 0.2.3
+Version: 0.2.4
 Summary: Publish Markdown files to Confluence wiki
 Home-page: https://github.com/hunyadi/md2conf
 Author: Levente Hunyadi
@@ -26,6 +26,8 @@ Requires-Dist: types-lxml>=2024.8.7
 Requires-Dist: markdown>=3.6
 Requires-Dist: types-markdown>=3.6
 Requires-Dist: pymdown-extensions>=10.9
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: types-PyYAML>=6.0
 Requires-Dist: requests>=2.32
 Requires-Dist: types-requests>=2.32
 
@@ -144,6 +146,12 @@ Provide generated-by prompt text in the Markdown file with a tag:
 
 Alternatively, use the `--generated-by GENERATED_BY` option. The tag takes precedence.
 
+### Publishing a directory
+
+*md2conf* allows you to convert and publish a directory of Markdown files rather than a single Markdown file if you pass a directory as `mdpath`. This will traverse the specified directory recursively, and synchronize each Markdown file.
+
+If a Markdown file doesn't yet pair up with a Confluence page, *md2conf* creates a new page and assigns a parent. Parent-child relationships are reflected in the navigation panel in Confluence. You can set a root page ID with the command-line option `-r`, which constitutes the topmost parent. (This could correspond to the landing page of your Confluence space. The Confluence page ID is always revealed when you edit a page.) Whenever a directory contains the file `index.md` or `README.md`, this page becomes the future parent page, and all Markdown files in this directory (and possibly nested directories) become its child pages (unless they already have a page ID). However, if an `index.md` or `README.md` file is subsequently found in one of the nested directories, it becomes the parent page of that directory, and any of its subdirectories.
+
 ### Ignoring files
 
 Skip files in a directory with rules defined in `.mdignore`. Each rule should occupy a single line. Rules follow the syntax of [fnmatch](https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatch). Specifically, `?` matches any single character, and `*` matches zero or more characters. For example, use `up-*.md` to exclude Markdown files that start with `up-`. Lines that start with `#` are treated as comments.

markdown_to_confluence-0.2.4.dist-info/RECORD

@@ -0,0 +1,21 @@
+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,,

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

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

md2conf/application.py

@@ -3,6 +3,8 @@ import os.path
 from pathlib import Path
 from typing import Dict, List, Optional
 
+import yaml
+
 from .api import ConfluencePage, ConfluenceSession
 from .converter import (
     ConfluenceDocument,
@@ -10,6 +12,7 @@ from .converter import (
     ConfluencePageMetadata,
     ConfluenceQualifiedID,
     attachment_name,
+    extract_frontmatter,
     extract_qualified_id,
     read_qualified_id,
 )
@@ -99,15 +102,15 @@ class Application:
                 continue
 
             if entry.is_file():
-                files.append((Path(local_dir) / entry.name).absolute())
+                files.append(Path(local_dir) / entry.name)
             elif entry.is_dir():
-                directories.append((Path(local_dir) / entry.name).absolute())
+                directories.append(Path(local_dir) / entry.name)
 
         # make page act as parent node in Confluence
         parent_id: Optional[ConfluenceQualifiedID] = None
-        if "index.md" in files:
+        if (Path(local_dir) / "index.md") in files:
             parent_id = read_qualified_id(Path(local_dir) / "index.md")
-        elif "README.md" in files:
+        elif (Path(local_dir) / "README.md") in files:
             parent_id = read_qualified_id(Path(local_dir) / "README.md")
 
         if parent_id is None:
@@ -137,6 +140,8 @@ class Application:
             document = f.read()
 
         qualified_id, document = extract_qualified_id(document)
+        frontmatter, document = extract_frontmatter(document)
+
         if qualified_id is not None:
             confluence_page = self.api.get_page(
                 qualified_id.page_id, space_key=qualified_id.space_key
@@ -147,6 +152,14 @@ class Application:
                     f"expected: parent page ID for Markdown file with no linked Confluence page: {absolute_path}"
                 )
 
+            # assign title from frontmatter if present
+            if title is None and frontmatter is not None:
+                properties = yaml.safe_load(frontmatter)
+                if isinstance(properties, dict):
+                    property_title = properties.get("title")
+                    if isinstance(property_title, str):
+                        title = property_title
+
             confluence_page = self._create_page(
                 absolute_path, document, title, parent_id
             )

md2conf/converter.py

@@ -338,10 +338,10 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
         anchor.tail = heading.text
         heading.text = None
 
-    def _transform_link(self, anchor: ET._Element) -> None:
+    def _transform_link(self, anchor: ET._Element) -> Optional[ET._Element]:
         url = anchor.attrib["href"]
         if is_absolute_url(url):
-            return
+            return None
 
         LOGGER.debug(f"found link {url} relative to {self.path}")
         relative_url: ParseResult = urlparse(url)
@@ -354,8 +354,23 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
             and not relative_url.query
         ):
             LOGGER.debug(f"found local URL: {url}")
-            anchor.attrib["href"] = url
-            return
+            if self.options.heading_anchors:
+                # <ac:link ac:anchor="anchor"><ac:link-body>...</ac:link-body></ac:link>
+                target = relative_url.fragment.lstrip("#")
+                link_body = AC("link-body", {}, *list(anchor))
+                link_body.text = anchor.text
+                link_wrapper = AC(
+                    "link",
+                    {
+                        ET.QName(namespaces["ac"], "anchor"): target,
+                    },
+                    link_body,
+                )
+                link_wrapper.tail = anchor.tail
+                return link_wrapper
+            else:
+                anchor.attrib["href"] = url
+                return None
 
         # convert the relative URL to absolute URL based on the base path value, then look up
         # the absolute path in the page metadata dictionary to discover the relative path
@@ -366,7 +381,7 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
             if self.options.ignore_invalid_url:
                 LOGGER.warning(msg)
                 anchor.attrib.pop("href")
-                return
+                return None
             else:
                 raise DocumentError(msg)
 
@@ -378,7 +393,7 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
             if self.options.ignore_invalid_url:
                 LOGGER.warning(msg)
                 anchor.attrib.pop("href")
-                return
+                return None
             else:
                 raise DocumentError(msg)
 
@@ -404,6 +419,7 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
 
         LOGGER.debug(f"transformed relative URL: {url} to URL: {transformed_url}")
         anchor.attrib["href"] = transformed_url
+        return None
 
     def _transform_image(self, image: ET._Element) -> ET._Element:
         path: str = image.attrib["src"]
@@ -803,8 +819,7 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
 
         # <a href="..."> ... </a>
         elif child.tag == "a":
-            self._transform_link(child)
-            return None
+            return self._transform_link(child)
 
         # <pre><code class="language-java"> ... </code></pre>
         elif child.tag == "pre" and len(child) == 1 and child[0].tag == "code":
@@ -829,16 +844,16 @@ class DocumentError(RuntimeError):
     pass
 
 
-def extract_value(pattern: str, string: str) -> Tuple[Optional[str], str]:
+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 ""
 
-    string = re.sub(pattern, _repl_func, string, 1, re.ASCII)
+    text = re.sub(pattern, _repl_func, text, 1, re.ASCII)
     value = values[0] if values else None
-    return value, string
+    return value, text
 
 
 @dataclass
@@ -851,20 +866,24 @@ class ConfluenceQualifiedID:
         self.space_key = space_key
 
 
-def extract_qualified_id(string: str) -> Tuple[Optional[ConfluenceQualifiedID], str]:
+def extract_qualified_id(text: str) -> Tuple[Optional[ConfluenceQualifiedID], str]:
     "Extracts the Confluence page ID and space key from a Markdown document."
 
-    page_id, string = extract_value(r"<!--\s+confluence-page-id:\s*(\d+)\s+-->", string)
+    page_id, text = extract_value(r"<!--\s+confluence-page-id:\s*(\d+)\s+-->", text)
 
     if page_id is None:
-        return None, string
+        return None, text
 
     # extract Confluence space key
-    space_key, string = extract_value(
-        r"<!--\s+confluence-space-key:\s*(\S+)\s+-->", string
-    )
+    space_key, text = extract_value(r"<!--\s+confluence-space-key:\s*(\S+)\s+-->", text)
+
+    return ConfluenceQualifiedID(page_id, space_key), text
+
+
+def extract_frontmatter(text: str) -> Tuple[Optional[str], str]:
+    "Extracts the front matter from a Markdown document."
 
-    return ConfluenceQualifiedID(page_id, space_key), string
+    return extract_value(r"(?ms)\A---$(.+?)^---$", text)
 
 
 def read_qualified_id(absolute_path: Path) -> Optional[ConfluenceQualifiedID]:
@@ -941,7 +960,7 @@ class ConfluenceDocument:
         )
 
         # extract frontmatter
-        frontmatter, text = extract_value(r"(?ms)\A---$(.+?)^---$", text)
+        frontmatter, text = extract_frontmatter(text)
 
         # convert to HTML
         html = markdown_to_html(text)

md2conf/mermaid.py

@@ -49,10 +49,9 @@ def render(source: str, output_format: Literal["png", "svg"] = "png") -> bytes:
         "--outputFormat",
         output_format,
     ]
+    root = os.path.dirname(__file__)
     if is_docker():
-        cmd.extend(
-            ["-p", os.path.join(os.path.dirname(__file__), "puppeteer-config.json")]
-        )
+        cmd.extend(["-p", os.path.join(root, "puppeteer-config.json")])
     LOGGER.debug(f"Executing: {' '.join(cmd)}")
     try:
         proc = subprocess.Popen(

md2conf/processor.py

@@ -79,9 +79,9 @@ class Processor:
                 continue
 
             if entry.is_file():
-                files.append((Path(local_dir) / entry.name).absolute())
+                files.append(Path(local_dir) / entry.name)
             elif entry.is_dir():
-                directories.append((Path(local_dir) / entry.name).absolute())
+                directories.append(Path(local_dir) / entry.name)
 
         for doc in files:
             metadata = self._get_page(doc)

markdown_to_confluence-0.2.3.dist-info/RECORD

@@ -1,21 +0,0 @@
-md2conf/__init__.py,sha256=ypRfZF5ef0nZONGa1E9S2htodyslp3uPDgRUhUD8St4,402
-md2conf/__main__.py,sha256=_qUspNQmQdhpH4Myh9vXDcauPyUx_FyEzNtaW_c8ytY,6601
-md2conf/api.py,sha256=bP3Kp4PsGQrPyQMOs-MwE2Znl1ewuKNslMCv7AtXIT0,16366
-md2conf/application.py,sha256=GUMPZUe_jZTBszKDyh4y-jeOp83VKCR3b_EHmzcL5Qs,7778
-md2conf/converter.py,sha256=F75UtnCR3vxAE1W8JxZ5wmfzgtJLTeQvDN2jH49fNXU,33466
-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=a7PVcd7kcFBOMw7Z2mOfvWC1JIVR4Q1EkkanLk1SLx0,1981
-md2conf/processor.py,sha256=qnoO7kTPF2y5uUATnqGSkgVP2DJJiR8DwkUqWavE6r4,4036
-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.3.dist-info/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
-markdown_to_confluence-0.2.3.dist-info/METADATA,sha256=Z7ts-W_aUJiau-mnFZIY6RPF5OdX_xCN081FCW4BNa8,11585
-markdown_to_confluence-0.2.3.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-markdown_to_confluence-0.2.3.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
-markdown_to_confluence-0.2.3.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
-markdown_to_confluence-0.2.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-markdown_to_confluence-0.2.3.dist-info/RECORD,,