markdown-to-confluence 0.2.7__tar.gz → 0.3.1__tar.gz

{markdown_to_confluence-0.2.7/markdown_to_confluence.egg-info → markdown_to_confluence-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: markdown-to-confluence
-Version: 0.2.7
+Version: 0.3.1
 Summary: Publish Markdown files to Confluence wiki
 Home-page: https://github.com/hunyadi/md2conf
 Author: Levente Hunyadi
@@ -12,20 +12,20 @@ Classifier: Intended Audience :: End Users/Desktop
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: lxml>=5.3
-Requires-Dist: types-lxml>=2024.11.8
+Requires-Dist: types-lxml>=2024.12.13
 Requires-Dist: markdown>=3.7
 Requires-Dist: types-markdown>=3.7
-Requires-Dist: pymdown-extensions>=10.12
+Requires-Dist: pymdown-extensions>=10.14
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: types-PyYAML>=6.0
 Requires-Dist: requests>=2.32
@@ -57,6 +57,8 @@ This Python package
 * [Collapsed sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
 * [Mermaid diagrams](https://mermaid.live/) in code blocks (converted to images)
 
+Whenever possible, the implementation uses [Confluence REST API v2](https://developer.atlassian.com/cloud/confluence/rest/v2/) to fetch space properties, and get, create or update page content.
+
 ## Installation
 
 Install the core package from PyPI:
@@ -160,6 +162,41 @@ First, *md2conf* builds an index of pages in the directory hierarchy. The index
 
 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.
 
+The concepts above are illustrated in the following sections.
+
+#### File-system directory hierarchy
+
+The title of each Markdown file (either the text of the first heading (`#`), or the title specified in front-matter) is shown next to the file name.
+
+```
+.
+├── computer-science
+│   ├── index.md: Introduction to computer science
+│   ├── algebra.md: Linear algebra
+│   └── algorithms.md: Theory of algorithms
+└── machine-learning
+    ├── README.md: AI and ML
+    ├── awareness.md: Consciousness and intelligence
+    └── statistics
+        ├── index.md: Introduction to statistics
+        └── median.md: Mean vs. median
+```
+
+#### Page hierarchy in Confluence
+
+Observe how `index.md` and `README.md` files have assumed parent (or ancestor) role for any Markdown files in the same directory (or below).
+
+```
+root
+├── Introduction to computer science
+│   ├── Linear algebra
+│   └── Theory of algorithms
+└── AI and ML
+    ├── Consciousness and intelligence
+    └── Introduction to statistics
+        └── Mean vs. median
+```
+
 ### 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.
@@ -214,7 +251,7 @@ options:
   --local               Write XHTML-based Confluence Storage Format files locally without invoking Confluence API.
   --headers [KEY=VALUE ...]
                         Apply custom headers to all Confluence API requests.
-  --webui-links         Enable Confluence Web UI links.
+  --webui-links         Enable Confluence Web UI links. (Typically required for on-prem versions of Confluence.)
 ```
 
 ### Using the Docker container

markdown_to_confluence-0.2.7/PKG-INFO → markdown_to_confluence-0.3.1/README.md

@@ -1,36 +1,3 @@
-Metadata-Version: 2.1
-Name: markdown-to-confluence
-Version: 0.2.7
-Summary: Publish Markdown files to Confluence wiki
-Home-page: https://github.com/hunyadi/md2conf
-Author: Levente Hunyadi
-Author-email: hunyadi@gmail.com
-License: MIT
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Typing :: Typed
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: lxml>=5.3
-Requires-Dist: types-lxml>=2024.11.8
-Requires-Dist: markdown>=3.7
-Requires-Dist: types-markdown>=3.7
-Requires-Dist: pymdown-extensions>=10.12
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: types-PyYAML>=6.0
-Requires-Dist: requests>=2.32
-Requires-Dist: types-requests>=2.32
-
 # Publish Markdown files to Confluence wiki
 
 Contributors to software projects typically write documentation in Markdown format and host Markdown files in collaborative version control systems (VCS) such as GitHub or GitLab to track changes and facilitate the review process. However, not everyone at a company has access to VCS, and documents are often circulated in Confluence wiki instead.
@@ -57,6 +24,8 @@ This Python package
 * [Collapsed sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
 * [Mermaid diagrams](https://mermaid.live/) in code blocks (converted to images)
 
+Whenever possible, the implementation uses [Confluence REST API v2](https://developer.atlassian.com/cloud/confluence/rest/v2/) to fetch space properties, and get, create or update page content.
+
 ## Installation
 
 Install the core package from PyPI:
@@ -160,6 +129,41 @@ First, *md2conf* builds an index of pages in the directory hierarchy. The index
 
 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.
 
+The concepts above are illustrated in the following sections.
+
+#### File-system directory hierarchy
+
+The title of each Markdown file (either the text of the first heading (`#`), or the title specified in front-matter) is shown next to the file name.
+
+```
+.
+├── computer-science
+│   ├── index.md: Introduction to computer science
+│   ├── algebra.md: Linear algebra
+│   └── algorithms.md: Theory of algorithms
+└── machine-learning
+    ├── README.md: AI and ML
+    ├── awareness.md: Consciousness and intelligence
+    └── statistics
+        ├── index.md: Introduction to statistics
+        └── median.md: Mean vs. median
+```
+
+#### Page hierarchy in Confluence
+
+Observe how `index.md` and `README.md` files have assumed parent (or ancestor) role for any Markdown files in the same directory (or below).
+
+```
+root
+├── Introduction to computer science
+│   ├── Linear algebra
+│   └── Theory of algorithms
+└── AI and ML
+    ├── Consciousness and intelligence
+    └── Introduction to statistics
+        └── Mean vs. median
+```
+
 ### 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.
@@ -214,7 +218,7 @@ options:
   --local               Write XHTML-based Confluence Storage Format files locally without invoking Confluence API.
   --headers [KEY=VALUE ...]
                         Apply custom headers to all Confluence API requests.
-  --webui-links         Enable Confluence Web UI links.
+  --webui-links         Enable Confluence Web UI links. (Typically required for on-prem versions of Confluence.)
 ```
 
 ### Using the Docker container

markdown_to_confluence-0.2.7/README.md → markdown_to_confluence-0.3.1/markdown_to_confluence.egg-info/PKG-INFO

@@ -1,3 +1,36 @@
+Metadata-Version: 2.2
+Name: markdown-to-confluence
+Version: 0.3.1
+Summary: Publish Markdown files to Confluence wiki
+Home-page: https://github.com/hunyadi/md2conf
+Author: Levente Hunyadi
+Author-email: hunyadi@gmail.com
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml>=5.3
+Requires-Dist: types-lxml>=2024.12.13
+Requires-Dist: markdown>=3.7
+Requires-Dist: types-markdown>=3.7
+Requires-Dist: pymdown-extensions>=10.14
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: types-PyYAML>=6.0
+Requires-Dist: requests>=2.32
+Requires-Dist: types-requests>=2.32
+
 # Publish Markdown files to Confluence wiki
 
 Contributors to software projects typically write documentation in Markdown format and host Markdown files in collaborative version control systems (VCS) such as GitHub or GitLab to track changes and facilitate the review process. However, not everyone at a company has access to VCS, and documents are often circulated in Confluence wiki instead.
@@ -24,6 +57,8 @@ This Python package
 * [Collapsed sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
 * [Mermaid diagrams](https://mermaid.live/) in code blocks (converted to images)
 
+Whenever possible, the implementation uses [Confluence REST API v2](https://developer.atlassian.com/cloud/confluence/rest/v2/) to fetch space properties, and get, create or update page content.
+
 ## Installation
 
 Install the core package from PyPI:
@@ -127,6 +162,41 @@ First, *md2conf* builds an index of pages in the directory hierarchy. The index
 
 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.
 
+The concepts above are illustrated in the following sections.
+
+#### File-system directory hierarchy
+
+The title of each Markdown file (either the text of the first heading (`#`), or the title specified in front-matter) is shown next to the file name.
+
+```
+.
+├── computer-science
+│   ├── index.md: Introduction to computer science
+│   ├── algebra.md: Linear algebra
+│   └── algorithms.md: Theory of algorithms
+└── machine-learning
+    ├── README.md: AI and ML
+    ├── awareness.md: Consciousness and intelligence
+    └── statistics
+        ├── index.md: Introduction to statistics
+        └── median.md: Mean vs. median
+```
+
+#### Page hierarchy in Confluence
+
+Observe how `index.md` and `README.md` files have assumed parent (or ancestor) role for any Markdown files in the same directory (or below).
+
+```
+root
+├── Introduction to computer science
+│   ├── Linear algebra
+│   └── Theory of algorithms
+└── AI and ML
+    ├── Consciousness and intelligence
+    └── Introduction to statistics
+        └── Mean vs. median
+```
+
 ### 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.
@@ -181,7 +251,7 @@ options:
   --local               Write XHTML-based Confluence Storage Format files locally without invoking Confluence API.
   --headers [KEY=VALUE ...]
                         Apply custom headers to all Confluence API requests.
-  --webui-links         Enable Confluence Web UI links.
+  --webui-links         Enable Confluence Web UI links. (Typically required for on-prem versions of Confluence.)
 ```
 
 ### Using the Docker container

{markdown_to_confluence-0.2.7 → markdown_to_confluence-0.3.1}/markdown_to_confluence.egg-info/SOURCES.txt

@@ -23,7 +23,6 @@ md2conf/processor.py
 md2conf/properties.py
 md2conf/puppeteer-config.json
 md2conf/py.typed
-md2conf/util.py
 tests/test_conversion.py
 tests/test_matcher.py
 tests/test_mermaid.py

{markdown_to_confluence-0.2.7 → markdown_to_confluence-0.3.1}/markdown_to_confluence.egg-info/requires.txt

@@ -1,8 +1,8 @@
 lxml>=5.3
-types-lxml>=2024.11.8
+types-lxml>=2024.12.13
 markdown>=3.7
 types-markdown>=3.7
-pymdown-extensions>=10.12
+pymdown-extensions>=10.14
 pyyaml>=6.0
 types-PyYAML>=6.0
 requests>=2.32

{markdown_to_confluence-0.2.7 → markdown_to_confluence-0.3.1}/md2conf/__init__.py

@@ -5,9 +5,9 @@ Parses Markdown files, converts Markdown content into the Confluence Storage For
 Confluence API endpoints to upload images and content.
 """
 
-__version__ = "0.2.7"
+__version__ = "0.3.1"
 __author__ = "Levente Hunyadi"
-__copyright__ = "Copyright 2022-2024, Levente Hunyadi"
+__copyright__ = "Copyright 2022-2025, Levente Hunyadi"
 __license__ = "MIT"
 __maintainer__ = "Levente Hunyadi"
 __status__ = "Production"

{markdown_to_confluence-0.2.7 → markdown_to_confluence-0.3.1}/md2conf/__main__.py

@@ -4,7 +4,7 @@ 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
+Copyright 2022-2025, Levente Hunyadi
 
 :see: https://github.com/hunyadi/md2conf
 """
@@ -38,9 +38,12 @@ 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"]
+    local: bool
+    headers: dict[str, str]
     webui_links: bool
 
 
@@ -107,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.",
@@ -169,14 +178,12 @@ def main() -> None:
         "--webui-links",
         action="store_true",
         default=False,
-        help="Enable Confluence Web UI links.",
+        help="Enable Confluence Web UI links. (Typically required for on-prem versions of Confluence.)",
     )
 
     args = Arguments()
     parser.parse_args(namespace=args)
 
-    # NOTE:  If we switch to modern type aware CLI tool like typer
-    #  the following line won't be necessary
     args.mdpath = Path(args.mdpath)
 
     logging.basicConfig(
@@ -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,