mkdocs2confluence 0.6.0__tar.gz → 0.6.1__tar.gz

{mkdocs2confluence-0.6.0/src/mkdocs2confluence.egg-info → mkdocs2confluence-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.6.0
+Version: 0.6.1
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -41,6 +41,7 @@ Dynamic: license-file
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
 [![PyPI](https://img.shields.io/pypi/v/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Downloads](https://img.shields.io/pypi/dm/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
 [![Latest Release](https://img.shields.io/github/v/release/jeckyl2010/mkdocs2confluence)](https://github.com/jeckyl2010/mkdocs2confluence/releases/latest)
 [![CI](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml)
 [![Release](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml)

{mkdocs2confluence-0.6.0 → mkdocs2confluence-0.6.1}/README.md

@@ -3,6 +3,7 @@
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
 [![PyPI](https://img.shields.io/pypi/v/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Downloads](https://img.shields.io/pypi/dm/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
 [![Latest Release](https://img.shields.io/github/v/release/jeckyl2010/mkdocs2confluence)](https://github.com/jeckyl2010/mkdocs2confluence/releases/latest)
 [![CI](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml)
 [![Release](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml)

{mkdocs2confluence-0.6.0 → mkdocs2confluence-0.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.6.0"
+version = "0.6.1"
 description = "Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more"
 readme = "README.md"
 license = { text = "GPL-3.0-or-later" }
@@ -88,4 +88,11 @@ exclude_lines = [
   "pragma: no cover",
   "if TYPE_CHECKING:",
   "raise NotImplementedError",
-]
+]
+
+[dependency-groups]
+dev = [
+    "pip-audit>=2.10.0",
+    "radon>=6.0.1",
+    "vulture>=2.16",
+]

{mkdocs2confluence-0.6.0 → mkdocs2confluence-0.6.1/src/mkdocs2confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.6.0
+Version: 0.6.1
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -41,6 +41,7 @@ Dynamic: license-file
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
 [![PyPI](https://img.shields.io/pypi/v/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Downloads](https://img.shields.io/pypi/dm/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
 [![Latest Release](https://img.shields.io/github/v/release/jeckyl2010/mkdocs2confluence)](https://github.com/jeckyl2010/mkdocs2confluence/releases/latest)
 [![CI](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml)
 [![Release](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml)

{mkdocs2confluence-0.6.0 → mkdocs2confluence-0.6.1}/src/mkdocs_to_confluence/loader/config.py

@@ -107,7 +107,7 @@ def _make_env_loader() -> type[yaml.SafeLoader]:
 
     # Catch-all: any other unknown tag (e.g. !!python/name:... used by
     # MkDocs Material) is silently ignored — we only care about nav/site_name.
-    def _ignore(loader: yaml.SafeLoader, tag_suffix: str, node: yaml.Node) -> None:
+    def _ignore(loader: yaml.SafeLoader, _tag_suffix: str, node: yaml.Node) -> None:
         return None
 
     _Loader.add_multi_constructor("", _ignore)  # type: ignore[no-untyped-call]

{mkdocs2confluence-0.6.0 → mkdocs2confluence-0.6.1}/src/mkdocs_to_confluence/loader/nav.py

@@ -39,7 +39,7 @@ class NavNode:
         return self.docs_path is not None
 
 
-def resolve_nav(config: MkDocsConfig, mkdocs_root: Path | None = None) -> list[NavNode]:
+def resolve_nav(config: MkDocsConfig) -> list[NavNode]:
     """Resolve *config.nav* into a list of top-level :class:`NavNode` objects.
 
     When ``config.nav`` is ``None`` (e.g. projects using ``awesome-pages`` or
@@ -48,8 +48,6 @@ def resolve_nav(config: MkDocsConfig, mkdocs_root: Path | None = None) -> list[N
 
     Args:
         config: Parsed :class:`~mkdocs_to_confluence.loader.config.MkDocsConfig`.
-        mkdocs_root: Directory containing ``mkdocs.yml``.  Used only to compute
-            ``docs_dir`` when it is not already absolute; defaults to CWD.
 
     Returns:
         List of top-level :class:`NavNode` instances.

{mkdocs2confluence-0.6.0 → mkdocs2confluence-0.6.1}/src/mkdocs_to_confluence/preprocess/includes.py

@@ -290,7 +290,7 @@ def _resolve_include_path(rel_path: str, source_path: Path, docs_dir: Path) -> P
     """
     for base in (docs_dir, source_path.parent):
         candidate = (base / rel_path).resolve()
-        if candidate.is_file():
+        if candidate.is_file() and candidate.is_relative_to(base.resolve()):
             return candidate
     return None
 

{mkdocs2confluence-0.6.0 → mkdocs2confluence-0.6.1}/src/mkdocs_to_confluence/publisher/pipeline.py

@@ -14,6 +14,7 @@ The pipeline has two phases:
 from __future__ import annotations
 
 import hashlib
+import re
 from dataclasses import dataclass, field
 from datetime import datetime, timezone
 from pathlib import Path
@@ -57,7 +58,7 @@ if TYPE_CHECKING:
 
 _Action = Literal["create", "update", "skip", "section"]
 
-_FRONT_MATTER_RE = __import__("re").compile(r"\A---\s*\n(.*?\n?)---\s*\n?", __import__("re").DOTALL)
+_FRONT_MATTER_RE = re.compile(r"\A---\s*\n(.*?\n?)---\s*\n?", re.DOTALL)
 
 
 @dataclass
@@ -457,6 +458,184 @@ def _upload_assets(
     return uploaded, skipped, errors
 
 
+def _execute_folder_action(
+    action: PageAction,
+    client: ConfluenceClient,
+    space_id: str,
+    root_page_id: str | None,
+    report: PublishReport,
+) -> None:
+    """Handle folder create/find for a single folder action."""
+    if action.page_id is not None:
+        # Already found at plan time — reuse.
+        report.updated += 1
+    elif action.parent_is_folder or action.parent_id == root_page_id:
+        # Parent is a Confluence folder, or this is a top-level section
+        # directly under the configured root page — use native folder API.
+        existing_folder = None
+        if action.parent_id is not None:
+            try:
+                existing_folder = client.find_folder_under(
+                    action.parent_id,
+                    action.title,
+                    parent_is_folder=action.parent_is_folder,
+                )
+            except Exception as find_exc:
+                print(
+                    f"         [warn] find_folder_under failed "
+                    f"(parent_id={action.parent_id}): {find_exc}"
+                )
+        if existing_folder is not None:
+            action.page_id = str(existing_folder["id"])
+            report.updated += 1
+        else:
+            folder_parent = (
+                action.parent_id if action.parent_is_folder else None
+            )
+            folder = client.create_folder(
+                space_id, action.title, parent_id=folder_parent
+            )
+            action.page_id = str(folder["id"])
+            report.created += 1
+            print(
+                f"         folder id={action.page_id}"
+                f"  parent_id={action.parent_id}"
+                f"  parent_is_folder={action.parent_is_folder}"
+            )
+    else:
+        # Parent is a dynamically-created page (e.g. a section-index page).
+        # Confluence folders cannot be nested under pages — use a stub page.
+        action.is_folder = False
+        existing = client.find_page(space_id, action.title)
+        if existing is not None:
+            action.page_id = str(existing["id"])
+            report.updated += 1
+        else:
+            stub = client.create_page(
+                space_id, action.title, "", parent_id=action.parent_id,
+            )
+            action.page_id = str(stub["id"])
+            report.created += 1
+
+
+def _execute_page_action(
+    action: PageAction,
+    client: ConfluenceClient,
+    space_id: str,
+    report: PublishReport,
+) -> None:
+    """Handle create/update (with stale fallback) for a single page action."""
+    if action.action == "create":
+        page = client.create_page(
+            space_id,
+            action.title,
+            action.xhtml or "",
+            parent_id=action.parent_id,
+        )
+        action.page_id = str(page["id"])
+        report.created += 1
+        try:
+            client.stamp_managed(action.page_id)
+        except Exception:
+            pass  # non-fatal
+    elif action.action == "update":
+        if action.page_id is None or action.version is None:
+            raise RuntimeError(
+                f"Update action for '{action.title}' is missing page_id or version"
+            )
+        try:
+            client.update_page(
+                action.page_id,
+                action.title,
+                action.xhtml or "",
+                action.version + 1,
+                parent_id=action.parent_id,
+            )
+            report.updated += 1
+        except ConfluenceError as upd_exc:
+            err = str(upd_exc)
+            # 404 = page deleted; 400 "another space" = stale page_id
+            # from a different Confluence space.  Both mean the existing
+            # page can't be updated — fall back to create a fresh one.
+            is_stale = "HTTP 404" in err or (
+                "HTTP 400" in err and "another space" in err.lower()
+            )
+            if not is_stale:
+                raise
+            print(
+                f"         [warn] update failed ({err[:80].strip()}) —"
+                " stale page_id; falling back to create"
+            )
+            action.page_id = None
+            page = client.create_page(
+                space_id,
+                action.title,
+                action.xhtml or "",
+                parent_id=action.parent_id,
+            )
+            action.page_id = str(page["id"])
+            report.created += 1
+            try:
+                client.stamp_managed(action.page_id)
+            except Exception:
+                pass  # non-fatal
+
+
+def _wire_children(
+    action: PageAction,
+    action_by_node: dict[int, PageAction],
+) -> None:
+    """Propagate a section's resolved page_id to all its direct children."""
+    if action.page_id is None:
+        return
+    for child_node in action.node.children:
+        child_action = action_by_node.get(id(child_node))
+        if child_action is not None:
+            child_action.parent_id = action.page_id
+            child_action.parent_is_folder = action.is_folder
+
+
+def _post_process_action(
+    action: PageAction,
+    client: ConfluenceClient,
+    *,
+    full_width: bool,
+    docs_dir: Path,
+    report: PublishReport,
+) -> None:
+    """Run all non-fatal post-create/update work for a single action."""
+    # Store content hash after create/update so the next run can skip unchanged pages.
+    if action.page_id and action.content_hash and action.action in ("create", "update"):
+        try:
+            client.set_content_hash(action.page_id, action.content_hash)
+        except Exception:
+            pass  # non-fatal
+
+    # Set full-width layout on newly created or updated pages (not folders).
+    if full_width and action.page_id and not action.is_folder:
+        try:
+            client.set_page_full_width(action.page_id)
+        except Exception:
+            pass  # non-fatal — page is published, layout is cosmetic
+
+    # Apply labels (tags) from front matter — non-fatal on failure.
+    if action.page_id and action.labels and not action.is_folder:
+        try:
+            client.set_page_labels(action.page_id, action.labels)
+        except Exception:
+            pass
+
+    # Upload assets — skip files whose mtime is not newer than Confluence.
+    if action.page_id and action.attachments:
+        uploaded, asset_skipped, asset_errors = _upload_assets(
+            action.page_id, action.attachments, docs_dir, client
+        )
+        report.assets_uploaded += uploaded
+        report.assets_skipped += asset_skipped
+        for name, msg in asset_errors:
+            report.errors.append((f"{action.title} / {name}", msg))
+
+
 def execute_publish(
     plan: list[PageAction],
     client: ConfluenceClient,
@@ -508,108 +687,9 @@ def execute_publish(
 
         try:
             if action.is_folder:
-                if action.page_id is not None:
-                    # Already found at plan time — reuse.
-                    report.updated += 1
-                elif action.parent_is_folder or action.parent_id == root_page_id:
-                    # Parent is a Confluence folder, or this is a top-level section
-                    # directly under the configured root page — use native folder API.
-                    existing_folder = None
-                    if action.parent_id is not None:
-                        try:
-                            existing_folder = client.find_folder_under(
-                                action.parent_id,
-                                action.title,
-                                parent_is_folder=action.parent_is_folder,
-                            )
-                        except Exception as find_exc:
-                            print(
-                                f"         [warn] find_folder_under failed "
-                                f"(parent_id={action.parent_id}): {find_exc}"
-                            )
-                    if existing_folder is not None:
-                        action.page_id = str(existing_folder["id"])
-                        report.updated += 1
-                    else:
-                        folder_parent = (
-                            action.parent_id if action.parent_is_folder else None
-                        )
-                        folder = client.create_folder(
-                            space_id, action.title, parent_id=folder_parent
-                        )
-                        action.page_id = str(folder["id"])
-                        report.created += 1
-                        print(
-                            f"         folder id={action.page_id}"
-                            f"  parent_id={action.parent_id}"
-                            f"  parent_is_folder={action.parent_is_folder}"
-                        )
-                else:
-                    # Parent is a dynamically-created page (e.g. a section-index page).
-                    # Confluence folders cannot be nested under pages — use a stub page.
-                    action.is_folder = False
-                    existing = client.find_page(space_id, action.title)
-                    if existing is not None:
-                        action.page_id = str(existing["id"])
-                        report.updated += 1
-                    else:
-                        stub = client.create_page(
-                            space_id, action.title, "", parent_id=action.parent_id,
-                        )
-                        action.page_id = str(stub["id"])
-                        report.created += 1
-            elif action.action == "create":
-                page = client.create_page(
-                    space_id,
-                    action.title,
-                    action.xhtml or "",
-                    parent_id=action.parent_id,
-                )
-                action.page_id = str(page["id"])
-                report.created += 1
-                try:
-                    client.stamp_managed(action.page_id)
-                except Exception:
-                    pass  # non-fatal
-            elif action.action == "update":
-                assert action.page_id is not None
-                assert action.version is not None
-                try:
-                    client.update_page(
-                        action.page_id,
-                        action.title,
-                        action.xhtml or "",
-                        action.version + 1,
-                        parent_id=action.parent_id,
-                    )
-                    report.updated += 1
-                except ConfluenceError as upd_exc:
-                    err = str(upd_exc)
-                    # 404 = page deleted; 400 "another space" = stale page_id
-                    # from a different Confluence space.  Both mean the existing
-                    # page can't be updated — fall back to create a fresh one.
-                    is_stale = "HTTP 404" in err or (
-                        "HTTP 400" in err and "another space" in err.lower()
-                    )
-                    if not is_stale:
-                        raise
-                    print(
-                        f"         [warn] update failed ({err[:80].strip()}) —"
-                        " stale page_id; falling back to create"
-                    )
-                    action.page_id = None
-                    page = client.create_page(
-                        space_id,
-                        action.title,
-                        action.xhtml or "",
-                        parent_id=action.parent_id,
-                    )
-                    action.page_id = str(page["id"])
-                    report.created += 1
-                    try:
-                        client.stamp_managed(action.page_id)
-                    except Exception:
-                        pass  # non-fatal
+                _execute_folder_action(action, client, space_id, root_page_id, report)
+            else:
+                _execute_page_action(action, client, space_id, report)
         except Exception as exc:
             report.errors.append((action.title, str(exc)))
             # Do NOT `continue` — all post-execute blocks below are guarded by
@@ -617,45 +697,10 @@ def execute_publish(
             # Critically, child parent_id wiring must still run for section
             # pages whose children were planned with parent_id=None.
 
-        # Once a folder/section's page_id is known, wire it into all direct
-        # children so that children created later use the correct parent_id.
         if action.node.is_section and action.page_id:
-            for child_node in action.node.children:
-                child_action = action_by_node.get(id(child_node))
-                if child_action is not None:
-                    child_action.parent_id = action.page_id
-                    child_action.parent_is_folder = action.is_folder
-
-        # Store content hash after create/update so the next run can skip unchanged pages.
-        if action.page_id and action.content_hash and action.action in ("create", "update"):
-            try:
-                client.set_content_hash(action.page_id, action.content_hash)
-            except Exception:
-                pass  # non-fatal
-
-        # Set full-width layout on newly created or updated pages (not folders).
-        if full_width and action.page_id and not action.is_folder:
-            try:
-                client.set_page_full_width(action.page_id)
-            except Exception:
-                pass  # non-fatal — page is published, layout is cosmetic
+            _wire_children(action, action_by_node)
 
-        # Apply labels (tags) from front matter — non-fatal on failure.
-        if action.page_id and action.labels and not action.is_folder:
-            try:
-                client.set_page_labels(action.page_id, action.labels)
-            except Exception:
-                pass
-
-        # Upload assets — skip files whose mtime is not newer than Confluence.
-        if action.page_id and action.attachments:
-            uploaded, asset_skipped, asset_errors = _upload_assets(
-                action.page_id, action.attachments, docs_dir, client
-            )
-            report.assets_uploaded += uploaded
-            report.assets_skipped += asset_skipped
-            for name, msg in asset_errors:
-                report.errors.append((f"{action.title} / {name}", msg))
+        _post_process_action(action, client, full_width=full_width, docs_dir=docs_dir, report=report)
 
     if prune and root_page_id:
         published_ids = {a.page_id for a in plan if a.page_id}