markdown-to-confluence 0.4.5__tar.gz → 0.4.6__tar.gz

{markdown_to_confluence-0.4.5/markdown_to_confluence.egg-info → markdown_to_confluence-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-to-confluence
-Version: 0.4.5
+Version: 0.4.6
 Summary: Publish Markdown files to Confluence wiki
 Author-email: Levente Hunyadi <hunyadi@gmail.com>
 Maintainer-email: Levente Hunyadi <hunyadi@gmail.com>
@@ -23,12 +23,14 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: certifi>=2025.8.3; python_version < "3.10"
 Requires-Dist: json_strong_typing>=0.4
 Requires-Dist: lxml>=6.0
 Requires-Dist: markdown>=3.8
 Requires-Dist: pymdown-extensions>=10.16
 Requires-Dist: PyYAML>=6.0
 Requires-Dist: requests>=2.32
+Requires-Dist: truststore>=0.10; python_version >= "3.10"
 Requires-Dist: typing-extensions>=4.14; python_version < "3.12"
 Provides-Extra: dev
 Requires-Dist: markdown_doc>=0.1.4; python_version >= "3.10" and extra == "dev"
@@ -143,7 +145,7 @@ export CONFLUENCE_SPACE_KEY='SPACE'
 
 On Windows, these can be set via system properties.
 
-If you use Atlassian scoped API tokens, you should set API URL, substituting `CLOUD_ID` with your own Cloud ID:
+If you use Atlassian scoped API tokens, you may want to set API URL directly, substituting `CLOUD_ID` with your own Cloud ID:
 
 ```sh
 export CONFLUENCE_API_URL='https://api.atlassian.com/ex/confluence/CLOUD_ID/'
@@ -151,20 +153,27 @@ export CONFLUENCE_API_URL='https://api.atlassian.com/ex/confluence/CLOUD_ID/'
 
 In this case, *md2conf* can automatically determine `CONFLUENCE_DOMAIN` and `CONFLUENCE_PATH`.
 
+If you can't find your `CLOUD_ID` but assign both `CONFLUENCE_DOMAIN` and `CONFLUENCE_PATH`, *md2conf* makes a best-effort attempt to determine `CONFLUENCE_API_URL`.
+
 ### Permissions
 
 The tool requires appropriate permissions in Confluence in order to invoke endpoints.
 
-Required scopes for scoped API tokens are as follows:
+We recommend the following scopes for scoped API tokens:
 
+* `read:attachment:confluence`
+* `read:content:confluence`
+* `read:content-details:confluence`
+* `read:label:confluence`
 * `read:page:confluence`
-* `write:page:confluence`
 * `read:space:confluence`
-* `write:space:confluence`
-* `read:attachment:confluence`
 * `write:attachment:confluence`
-* `read:label:confluence`
+* `write:content:confluence`
 * `write:label:confluence`
+* `write:page:confluence`
+* `delete:attachment:confluence`
+* `delete:content:confluence`
+* `delete:page:confluence`
 
 If a Confluence username is set, the tool uses HTTP *Basic* authentication to pass the username and the API key to Confluence REST API endpoints. If no username is provided, the tool authenticates with HTTP *Bearer*, and passes the API key as the bearer token.
 
@@ -331,6 +340,21 @@ The following table shows standard highlight colors (CSS `background-color`) tha
 
 If your Markdown lists or tables don't appear in Confluence as expected, verify that the list or table is delimited by a blank line both before and after, as per strict Markdown syntax. While some previewers accept a more lenient syntax (e.g. an itemized list immediately following a paragraph), *md2conf* uses [Python-Markdown](https://python-markdown.github.io/) internally to convert Markdown into XHTML, which expects the Markdown document to adhere to the stricter syntax.
 
+Likewise, if you have a nested list, make sure that nested items are indented by exactly ***four*** spaces as compared to the parent node:
+
+```markdown
+1. List item 1
+    * Nested item 1
+        1. Item 1
+        2. Item 2
+    * Nested item 2
+        - Item 3
+        - Item 4
+2. List item 2
+    1. Nested item 3
+    2. Nested item 4
+```
+
 ### Publishing images
 
 Local images referenced in a Markdown file are automatically published to Confluence as attachments to the page.
@@ -348,7 +372,7 @@ Inline formulas can be enclosed with `$` signs, or delimited with `\(` and `\)`,
 
 Block formulas can be enclosed with `$$`, or wrapped in code blocks specifying the language `math`:
 
-```md
+```markdown
 $$\int _{a}^{b}f(x)dx=F(b)-F(a)$$
 ```
 
@@ -385,7 +409,7 @@ Displaying math formulas in Confluence requires the extension [LaTeX Math for Co
 
 Use the pseudo-language `csf` in a Markdown code block to pass content directly to Confluence. The content must be a single XML node that conforms to Confluence Storage Format (typically an `ac:structured-macro`) but is otherwise not validated. The following example shows how to create a panel similar to an *info panel* but with custom background color and emoji. Notice that `ac:rich-text-body` uses XHTML, not Markdown.
 
-````md
+````markdown
 ```csf
 <ac:structured-macro ac:name="panel" ac:schema-version="1">
   <ac:parameter ac:name="panelIcon">:slight_smile:</ac:parameter>
@@ -496,7 +520,7 @@ If *md2conf* encounters a Markdown link that points to a file in the directory h
 
 *md2conf* implicitly defines some URLs, as if you included the following at the start of the Markdown document for each URL:
 
-```md
+```markdown
 [CUSTOM-URL]: https://example.com/path/to/resource
 ```
 
@@ -531,7 +555,7 @@ options:
   --api-url API_URL     Confluence API URL. Required for scoped tokens. Refer to documentation how to obtain one.
   -u, --username USERNAME
                         Confluence user name.
-  -a, --apikey, --api-key API_KEY
+  -a, --api-key API_KEY
                         Confluence API key. Refer to documentation how to obtain one.
   -s, --space SPACE     Confluence space key for pages to be published. If omitted, will default to user space.
   -l, --loglevel {debug,info,warning,error,critical}
@@ -550,8 +574,6 @@ options:
   --no-render-latex     Inline LaTeX formulas in Confluence page. (Marketplace app required to display.)
   --diagram-output-format {png,svg}
                         Format for rendering Mermaid and draw.io diagrams (default: 'png').
-  --render-mermaid-format FORMAT
-                        Format for rendering Mermaid diagrams (default: 'png').
   --heading-anchors     Place an anchor at each section heading with GitHub-style same-page identifiers.
   --no-heading-anchors  Don't place an anchor at each section heading.
   --ignore-invalid-url  Emit a warning but otherwise ignore relative URLs that point to ill-specified locations.

{markdown_to_confluence-0.4.5 → markdown_to_confluence-0.4.6}/README.md

@@ -99,7 +99,7 @@ export CONFLUENCE_SPACE_KEY='SPACE'
 
 On Windows, these can be set via system properties.
 
-If you use Atlassian scoped API tokens, you should set API URL, substituting `CLOUD_ID` with your own Cloud ID:
+If you use Atlassian scoped API tokens, you may want to set API URL directly, substituting `CLOUD_ID` with your own Cloud ID:
 
 ```sh
 export CONFLUENCE_API_URL='https://api.atlassian.com/ex/confluence/CLOUD_ID/'
@@ -107,20 +107,27 @@ export CONFLUENCE_API_URL='https://api.atlassian.com/ex/confluence/CLOUD_ID/'
 
 In this case, *md2conf* can automatically determine `CONFLUENCE_DOMAIN` and `CONFLUENCE_PATH`.
 
+If you can't find your `CLOUD_ID` but assign both `CONFLUENCE_DOMAIN` and `CONFLUENCE_PATH`, *md2conf* makes a best-effort attempt to determine `CONFLUENCE_API_URL`.
+
 ### Permissions
 
 The tool requires appropriate permissions in Confluence in order to invoke endpoints.
 
-Required scopes for scoped API tokens are as follows:
+We recommend the following scopes for scoped API tokens:
 
+* `read:attachment:confluence`
+* `read:content:confluence`
+* `read:content-details:confluence`
+* `read:label:confluence`
 * `read:page:confluence`
-* `write:page:confluence`
 * `read:space:confluence`
-* `write:space:confluence`
-* `read:attachment:confluence`
 * `write:attachment:confluence`
-* `read:label:confluence`
+* `write:content:confluence`
 * `write:label:confluence`
+* `write:page:confluence`
+* `delete:attachment:confluence`
+* `delete:content:confluence`
+* `delete:page:confluence`
 
 If a Confluence username is set, the tool uses HTTP *Basic* authentication to pass the username and the API key to Confluence REST API endpoints. If no username is provided, the tool authenticates with HTTP *Bearer*, and passes the API key as the bearer token.
 
@@ -287,6 +294,21 @@ The following table shows standard highlight colors (CSS `background-color`) tha
 
 If your Markdown lists or tables don't appear in Confluence as expected, verify that the list or table is delimited by a blank line both before and after, as per strict Markdown syntax. While some previewers accept a more lenient syntax (e.g. an itemized list immediately following a paragraph), *md2conf* uses [Python-Markdown](https://python-markdown.github.io/) internally to convert Markdown into XHTML, which expects the Markdown document to adhere to the stricter syntax.
 
+Likewise, if you have a nested list, make sure that nested items are indented by exactly ***four*** spaces as compared to the parent node:
+
+```markdown
+1. List item 1
+    * Nested item 1
+        1. Item 1
+        2. Item 2
+    * Nested item 2
+        - Item 3
+        - Item 4
+2. List item 2
+    1. Nested item 3
+    2. Nested item 4
+```
+
 ### Publishing images
 
 Local images referenced in a Markdown file are automatically published to Confluence as attachments to the page.
@@ -304,7 +326,7 @@ Inline formulas can be enclosed with `$` signs, or delimited with `\(` and `\)`,
 
 Block formulas can be enclosed with `$$`, or wrapped in code blocks specifying the language `math`:
 
-```md
+```markdown
 $$\int _{a}^{b}f(x)dx=F(b)-F(a)$$
 ```
 
@@ -341,7 +363,7 @@ Displaying math formulas in Confluence requires the extension [LaTeX Math for Co
 
 Use the pseudo-language `csf` in a Markdown code block to pass content directly to Confluence. The content must be a single XML node that conforms to Confluence Storage Format (typically an `ac:structured-macro`) but is otherwise not validated. The following example shows how to create a panel similar to an *info panel* but with custom background color and emoji. Notice that `ac:rich-text-body` uses XHTML, not Markdown.
 
-````md
+````markdown
 ```csf
 <ac:structured-macro ac:name="panel" ac:schema-version="1">
   <ac:parameter ac:name="panelIcon">:slight_smile:</ac:parameter>
@@ -452,7 +474,7 @@ If *md2conf* encounters a Markdown link that points to a file in the directory h
 
 *md2conf* implicitly defines some URLs, as if you included the following at the start of the Markdown document for each URL:
 
-```md
+```markdown
 [CUSTOM-URL]: https://example.com/path/to/resource
 ```
 
@@ -487,7 +509,7 @@ options:
   --api-url API_URL     Confluence API URL. Required for scoped tokens. Refer to documentation how to obtain one.
   -u, --username USERNAME
                         Confluence user name.
-  -a, --apikey, --api-key API_KEY
+  -a, --api-key API_KEY
                         Confluence API key. Refer to documentation how to obtain one.
   -s, --space SPACE     Confluence space key for pages to be published. If omitted, will default to user space.
   -l, --loglevel {debug,info,warning,error,critical}
@@ -506,8 +528,6 @@ options:
   --no-render-latex     Inline LaTeX formulas in Confluence page. (Marketplace app required to display.)
   --diagram-output-format {png,svg}
                         Format for rendering Mermaid and draw.io diagrams (default: 'png').
-  --render-mermaid-format FORMAT
-                        Format for rendering Mermaid diagrams (default: 'png').
   --heading-anchors     Place an anchor at each section heading with GitHub-style same-page identifiers.
   --no-heading-anchors  Don't place an anchor at each section heading.
   --ignore-invalid-url  Emit a warning but otherwise ignore relative URLs that point to ill-specified locations.

{markdown_to_confluence-0.4.5 → markdown_to_confluence-0.4.6/markdown_to_confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-to-confluence
-Version: 0.4.5
+Version: 0.4.6
 Summary: Publish Markdown files to Confluence wiki
 Author-email: Levente Hunyadi <hunyadi@gmail.com>
 Maintainer-email: Levente Hunyadi <hunyadi@gmail.com>
@@ -23,12 +23,14 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: certifi>=2025.8.3; python_version < "3.10"
 Requires-Dist: json_strong_typing>=0.4
 Requires-Dist: lxml>=6.0
 Requires-Dist: markdown>=3.8
 Requires-Dist: pymdown-extensions>=10.16
 Requires-Dist: PyYAML>=6.0
 Requires-Dist: requests>=2.32
+Requires-Dist: truststore>=0.10; python_version >= "3.10"
 Requires-Dist: typing-extensions>=4.14; python_version < "3.12"
 Provides-Extra: dev
 Requires-Dist: markdown_doc>=0.1.4; python_version >= "3.10" and extra == "dev"
@@ -143,7 +145,7 @@ export CONFLUENCE_SPACE_KEY='SPACE'
 
 On Windows, these can be set via system properties.
 
-If you use Atlassian scoped API tokens, you should set API URL, substituting `CLOUD_ID` with your own Cloud ID:
+If you use Atlassian scoped API tokens, you may want to set API URL directly, substituting `CLOUD_ID` with your own Cloud ID:
 
 ```sh
 export CONFLUENCE_API_URL='https://api.atlassian.com/ex/confluence/CLOUD_ID/'
@@ -151,20 +153,27 @@ export CONFLUENCE_API_URL='https://api.atlassian.com/ex/confluence/CLOUD_ID/'
 
 In this case, *md2conf* can automatically determine `CONFLUENCE_DOMAIN` and `CONFLUENCE_PATH`.
 
+If you can't find your `CLOUD_ID` but assign both `CONFLUENCE_DOMAIN` and `CONFLUENCE_PATH`, *md2conf* makes a best-effort attempt to determine `CONFLUENCE_API_URL`.
+
 ### Permissions
 
 The tool requires appropriate permissions in Confluence in order to invoke endpoints.
 
-Required scopes for scoped API tokens are as follows:
+We recommend the following scopes for scoped API tokens:
 
+* `read:attachment:confluence`
+* `read:content:confluence`
+* `read:content-details:confluence`
+* `read:label:confluence`
 * `read:page:confluence`
-* `write:page:confluence`
 * `read:space:confluence`
-* `write:space:confluence`
-* `read:attachment:confluence`
 * `write:attachment:confluence`
-* `read:label:confluence`
+* `write:content:confluence`
 * `write:label:confluence`
+* `write:page:confluence`
+* `delete:attachment:confluence`
+* `delete:content:confluence`
+* `delete:page:confluence`
 
 If a Confluence username is set, the tool uses HTTP *Basic* authentication to pass the username and the API key to Confluence REST API endpoints. If no username is provided, the tool authenticates with HTTP *Bearer*, and passes the API key as the bearer token.
 
@@ -331,6 +340,21 @@ The following table shows standard highlight colors (CSS `background-color`) tha
 
 If your Markdown lists or tables don't appear in Confluence as expected, verify that the list or table is delimited by a blank line both before and after, as per strict Markdown syntax. While some previewers accept a more lenient syntax (e.g. an itemized list immediately following a paragraph), *md2conf* uses [Python-Markdown](https://python-markdown.github.io/) internally to convert Markdown into XHTML, which expects the Markdown document to adhere to the stricter syntax.
 
+Likewise, if you have a nested list, make sure that nested items are indented by exactly ***four*** spaces as compared to the parent node:
+
+```markdown
+1. List item 1
+    * Nested item 1
+        1. Item 1
+        2. Item 2
+    * Nested item 2
+        - Item 3
+        - Item 4
+2. List item 2
+    1. Nested item 3
+    2. Nested item 4
+```
+
 ### Publishing images
 
 Local images referenced in a Markdown file are automatically published to Confluence as attachments to the page.
@@ -348,7 +372,7 @@ Inline formulas can be enclosed with `$` signs, or delimited with `\(` and `\)`,
 
 Block formulas can be enclosed with `$$`, or wrapped in code blocks specifying the language `math`:
 
-```md
+```markdown
 $$\int _{a}^{b}f(x)dx=F(b)-F(a)$$
 ```
 
@@ -385,7 +409,7 @@ Displaying math formulas in Confluence requires the extension [LaTeX Math for Co
 
 Use the pseudo-language `csf` in a Markdown code block to pass content directly to Confluence. The content must be a single XML node that conforms to Confluence Storage Format (typically an `ac:structured-macro`) but is otherwise not validated. The following example shows how to create a panel similar to an *info panel* but with custom background color and emoji. Notice that `ac:rich-text-body` uses XHTML, not Markdown.
 
-````md
+````markdown
 ```csf
 <ac:structured-macro ac:name="panel" ac:schema-version="1">
   <ac:parameter ac:name="panelIcon">:slight_smile:</ac:parameter>
@@ -496,7 +520,7 @@ If *md2conf* encounters a Markdown link that points to a file in the directory h
 
 *md2conf* implicitly defines some URLs, as if you included the following at the start of the Markdown document for each URL:
 
-```md
+```markdown
 [CUSTOM-URL]: https://example.com/path/to/resource
 ```
 
@@ -531,7 +555,7 @@ options:
   --api-url API_URL     Confluence API URL. Required for scoped tokens. Refer to documentation how to obtain one.
   -u, --username USERNAME
                         Confluence user name.
-  -a, --apikey, --api-key API_KEY
+  -a, --api-key API_KEY
                         Confluence API key. Refer to documentation how to obtain one.
   -s, --space SPACE     Confluence space key for pages to be published. If omitted, will default to user space.
   -l, --loglevel {debug,info,warning,error,critical}
@@ -550,8 +574,6 @@ options:
   --no-render-latex     Inline LaTeX formulas in Confluence page. (Marketplace app required to display.)
   --diagram-output-format {png,svg}
                         Format for rendering Mermaid and draw.io diagrams (default: 'png').
-  --render-mermaid-format FORMAT
-                        Format for rendering Mermaid diagrams (default: 'png').
   --heading-anchors     Place an anchor at each section heading with GitHub-style same-page identifiers.
   --no-heading-anchors  Don't place an anchor at each section heading.
   --ignore-invalid-url  Emit a warning but otherwise ignore relative URLs that point to ill-specified locations.

{markdown_to_confluence-0.4.5 → markdown_to_confluence-0.4.6}/markdown_to_confluence.egg-info/SOURCES.txt

@@ -13,13 +13,14 @@ markdown_to_confluence.egg-info/zip-safe
 md2conf/__init__.py
 md2conf/__main__.py
 md2conf/api.py
-md2conf/application.py
 md2conf/collection.py
 md2conf/converter.py
 md2conf/csf.py
 md2conf/domain.py
 md2conf/drawio.py
+md2conf/emoticon.py
 md2conf/entities.dtd
+md2conf/environment.py
 md2conf/extra.py
 md2conf/latex.py
 md2conf/local.py
@@ -28,7 +29,7 @@ md2conf/matcher.py
 md2conf/mermaid.py
 md2conf/metadata.py
 md2conf/processor.py
-md2conf/properties.py
+md2conf/publisher.py
 md2conf/puppeteer-config.json
 md2conf/py.typed
 md2conf/scanner.py

{markdown_to_confluence-0.4.5 → markdown_to_confluence-0.4.6}/markdown_to_confluence.egg-info/requires.txt

@@ -5,9 +5,15 @@ pymdown-extensions>=10.16
 PyYAML>=6.0
 requests>=2.32
 
+[:python_version < "3.10"]
+certifi>=2025.8.3
+
 [:python_version < "3.12"]
 typing-extensions>=4.14
 
+[:python_version >= "3.10"]
+truststore>=0.10
+
 [dev]
 types-lxml>=2025.3.30
 types-markdown>=3.8

{markdown_to_confluence-0.4.5 → markdown_to_confluence-0.4.6}/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.4.5"
+__version__ = "0.4.6"
 __author__ = "Levente Hunyadi"
 __copyright__ = "Copyright 2022-2025, Levente Hunyadi"
 __license__ = "MIT"

{markdown_to_confluence-0.4.5 → markdown_to_confluence-0.4.6}/md2conf/__main__.py

@@ -14,14 +14,15 @@ import logging
 import os.path
 import sys
 import typing
+from io import StringIO
 from pathlib import Path
 from typing import Any, Iterable, Literal, Optional, Sequence, Union
 
 from . import __version__
 from .domain import ConfluenceDocumentOptions, ConfluencePageID
+from .environment import ArgumentError, ConfluenceConnectionProperties, ConfluenceSiteProperties
 from .extra import override
 from .metadata import ConfluenceSiteMetadata
-from .properties import ArgumentError, ConfluenceConnectionProperties, ConfluenceSiteProperties
 
 
 class Arguments(argparse.Namespace):
@@ -68,30 +69,6 @@ class KwargsAppendAction(argparse.Action):
         setattr(namespace, self.dest, d)
 
 
-def unsupported(prefer: str) -> type[argparse.Action]:
-    class UnsupportedAction(argparse.Action):
-        """Display an error for unsupported command-line options."""
-
-        @override
-        def __call__(
-            self,
-            parser: argparse.ArgumentParser,
-            namespace: argparse.Namespace,
-            values: Union[None, str, Sequence[Any]],
-            option_string: Optional[str] = None,
-        ) -> None:
-            raise argparse.ArgumentError(
-                self,
-                f"this command-line option is no longer supported, use `--{prefer}`",
-            )
-
-        @override
-        def __repr__(self) -> str:
-            return f"{unsupported.__name__}({repr(prefer)})"
-
-    return UnsupportedAction
-
-
 class PositionalOnlyHelpFormatter(argparse.HelpFormatter):
     def _format_usage(
         self,
@@ -112,7 +89,7 @@ class PositionalOnlyHelpFormatter(argparse.HelpFormatter):
         return usage_str
 
 
-def main() -> None:
+def get_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(formatter_class=PositionalOnlyHelpFormatter)
     parser.prog = os.path.basename(os.path.dirname(__file__))
     parser.add_argument("--version", action="version", version=__version__)
@@ -127,7 +104,6 @@ def main() -> None:
     parser.add_argument("-u", "--username", help="Confluence user name.")
     parser.add_argument(
         "-a",
-        "--apikey",
         "--api-key",
         dest="api_key",
         help="Confluence API key. Refer to documentation how to obtain one.",
@@ -228,12 +204,6 @@ def main() -> None:
         default="png",
         help="Format for rendering Mermaid and draw.io diagrams (default: 'png').",
     )
-    parser.add_argument(
-        "--render-mermaid-format",
-        action=unsupported("diagram-output-format"),
-        metavar="FORMAT",
-        help="Format for rendering Mermaid diagrams (default: 'png').",
-    )
     parser.add_argument(
         "--heading-anchors",
         action="store_true",
@@ -272,7 +242,18 @@ def main() -> None:
         default=False,
         help="Enable Confluence Web UI links. (Typically required for on-prem versions of Confluence.)",
     )
+    return parser
+
 
+def get_help() -> str:
+    parser = get_parser()
+    with StringIO() as buf:
+        parser.print_help(file=buf)
+        return buf.getvalue()
+
+
+def main() -> None:
+    parser = get_parser()
     args = Arguments()
     parser.parse_args(namespace=args)
 
@@ -316,7 +297,7 @@ def main() -> None:
         from requests import HTTPError, JSONDecodeError
 
         from .api import ConfluenceAPI
-        from .application import Application
+        from .publisher import Publisher
 
         try:
             properties = ConfluenceConnectionProperties(
@@ -332,7 +313,7 @@ def main() -> None:
             parser.error(str(e))
         try:
             with ConfluenceAPI(properties) as api:
-                Application(
+                Publisher(
                     api,
                     options,
                 ).process(args.mdpath)