markdown-to-confluence 0.1.11__py3-none-any.whl → 0.1.13__py3-none-any.whl

{markdown_to_confluence-0.1.11.dist-info → markdown_to_confluence-0.1.13.dist-info}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022-2024 Levente Hunyadi
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022-2024 Levente Hunyadi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{markdown_to_confluence-0.1.11.dist-info → markdown_to_confluence-0.1.13.dist-info}/METADATA

@@ -1,163 +1,168 @@
-Metadata-Version: 2.1
-Name: markdown-to-confluence
-Version: 0.1.11
-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 >=4.9
-Requires-Dist: types-lxml >=2023.10.21
-Requires-Dist: markdown >=3.5
-Requires-Dist: types-markdown >=3.5
-Requires-Dist: pymdown-extensions >=10.3
-Requires-Dist: requests >=2.31
-Requires-Dist: types-requests >=2.31
-
-# 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.
-
-Replicating documentation to Confluence by hand is tedious, and a lack of automated synchronization with the project repositories where the documents live leads to outdated documentation.
-
-This Python package
-* parses Markdown files,
-* converts Markdown content into the Confluence Storage Format (XHTML),
-* invokes Confluence API endpoints to upload images and content.
-
-## Features
-
-* Sections and subsections
-* Text with **bold**, *italic*, `monospace`, <ins>underline</ins> and ~~strikethrough~~
-* Link to [external locations](http://example.com/)
-* Ordered and unordered lists
-* Code blocks (e.g. Python, JSON, XML)
-* Image references (uploaded as Confluence page attachments)
-* [Table of Contents](https://docs.gitlab.com/ee/user/markdown.html#table-of-contents)
-* [Admonitions](https://python-markdown.github.io/extensions/admonition/) (converted into *info*, *tip*, *note* and *warning* Confluence panels)
-
-## Getting started
-
-In order to get started, you will need
-* your organization domain name (e.g. `instructure.atlassian.net`),
-* base path for Confluence wiki (typically `/wiki/` for managed Confluence, `/` for on-premise)
-* your Confluence username (e.g. `levente.hunyadi@instructure.com`) (only if required by your deployment),
-* a Confluence API token (a string of alphanumeric characters), and
-* the space key in Confluence (e.g. `DAP`) you are publishing content to.
-
-### Obtaining an API token
-
-1. Log in to https://id.atlassian.com/manage/api-tokens.
-2. Click *Create API token*.
-3. From the dialog that appears, enter a memorable and concise *Label* for your token and click *Create*.
-4. Click *Copy to clipboard*, then paste the token to your script, or elsewhere to save.
-
-### Setting up the environment
-
-Confluence organization domain, base path, username, API token and space key can be specified at runtime or set as Confluence environment variables (e.g. add to your `~/.profile` on Linux, or `~/.bash_profile` or `~/.zshenv` on MacOS):
-```bash
-export CONFLUENCE_DOMAIN='instructure.atlassian.net'
-export CONFLUENCE_PATH='/wiki/'
-export CONFLUENCE_USER_NAME='levente.hunyadi@instructure.com'
-export CONFLUENCE_API_KEY='0123456789abcdef'
-export CONFLUENCE_SPACE_KEY='DAP'
-```
-
-On Windows, these can be set via system properties.
-
-### Permissions
-
-The tool requires appropriate permissions in Confluence in order to invoke endpoints.
-
-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.
-
-If you lack appropriate permissions, you will get an *Unauthorized* response from Confluence. The tool will emit a message that looks as follows:
-
-```
-2023-06-30 23:59:59,000 - ERROR - <module> [80] - 401 Client Error: Unauthorized for url: ...
-```
-
-### Associating a Markdown file with a wiki page
-
-Each Markdown file is associated with a Confluence wiki page with a Markdown comment:
-
-```markdown
-<!-- confluence-page-id: 85668266616 -->
-```
-
-The above tells the tool to synchronize the Markdown file with the given Confluence page ID. This implies that the Confluence wiki page must exist such that it has an ID. The comment can be placed anywhere in the source file.
-
-### Setting the Confluence space
-
-If you work in an environment where there are multiple Confluence spaces, and some Markdown pages may go into one space, whereas other pages may go into another, you can set the target space on a per-document basis:
-
-```markdown
-<!-- confluence-space-key: DAP -->
-```
-
-This overrides the default space set via command-line arguments or environment variables.
-
-### Setting generated-by prompt text for wiki pages
-
-In order to ensure readers are not editing a generated document, the tool adds a warning message at the top of the Confluence page as an *info panel*. You can customize the text that appears. The text can contain markup as per the [Confluence Storage Format](https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html), and is emitted directly into the *info panel* macro.
-
-Provide generated-by prompt text in the Markdown file with a tag:
-
-```markdown
-<!-- generated-by: Do not edit! Check out the <a href="https://example.com/project">original source</a>. -->
-```
-
-Alternatively, use the `--generated-by GENERATED_BY` option. The tag takes precedence.
-
-### Running the tool
-
-You execute the command-line tool `md2conf` to synchronize the Markdown file with Confluence:
-
-```console
-$ python3 -m md2conf sample/example.md
-```
-
-Use the `--help` switch to get a full list of supported command-line options:
-
-```console
-$ python3 -m md2conf --help
-usage: md2conf [-h] [-d DOMAIN] [-p PATH] [-u USERNAME] [-a APIKEY] [-s SPACE] [-l {debug,info,warning,error,critical}]
-               [--generated-by GENERATED_BY] [--no-generated-by] [--ignore-invalid-url]
-               mdpath
-
-positional arguments:
-  mdpath                Path to Markdown file or directory to convert and publish.
-
-options:
-  -h, --help            show this help message and exit
-  -d DOMAIN, --domain DOMAIN
-                        Confluence organization domain.
-  -p PATH, --path PATH  Base path for Confluece wiki.
-  -u USERNAME, --username USERNAME
-                        Confluence user name.
-  -a APIKEY, --apikey APIKEY
-                        Confluence API key. Refer to documentation how to obtain one.
-  -s SPACE, --space SPACE
-                        Confluence space key for pages to be published. If omitted, will default to user space.
-  -l {debug,info,warning,error,critical}, --loglevel {debug,info,warning,error,critical}
-                        Use this option to set the log verbosity.
-  --generated-by GENERATED_BY
-                        Add prompt to pages (default: 'This page has been generated with a tool.').
-  --no-generated-by     Do not add 'generated by a tool' prompt to pages.
-  --ignore-invalid-url  Emit a warning but otherwise ignore relative URLs that point to ill-specified locations.
-```
+Metadata-Version: 2.1
+Name: markdown-to-confluence
+Version: 0.1.13
+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.8.7
+Requires-Dist: markdown>=3.6
+Requires-Dist: types-markdown>=3.6
+Requires-Dist: pymdown-extensions>=10.9
+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.
+
+Replicating documentation to Confluence by hand is tedious, and a lack of automated synchronization with the project repositories where the documents live leads to outdated documentation.
+
+This Python package
+
+* parses Markdown files,
+* converts Markdown content into the Confluence Storage Format (XHTML),
+* invokes Confluence API endpoints to upload images and content.
+
+## Features
+
+* Sections and subsections
+* Text with **bold**, *italic*, `monospace`, <ins>underline</ins> and ~~strikethrough~~
+* Link to [external locations](http://example.com/)
+* Ordered and unordered lists
+* Code blocks (e.g. Python, JSON, XML)
+* Image references (uploaded as Confluence page attachments)
+* [Table of Contents](https://docs.gitlab.com/ee/user/markdown.html#table-of-contents)
+* [Admonitions](https://python-markdown.github.io/extensions/admonition/) (converted into *info*, *tip*, *note* and *warning* Confluence panels)
+
+## Getting started
+
+In order to get started, you will need
+
+* your organization domain name (e.g. `instructure.atlassian.net`),
+* base path for Confluence wiki (typically `/wiki/` for managed Confluence, `/` for on-premise)
+* your Confluence username (e.g. `levente.hunyadi@instructure.com`) (only if required by your deployment),
+* a Confluence API token (a string of alphanumeric characters), and
+* the space key in Confluence (e.g. `DAP`) you are publishing content to.
+
+### Obtaining an API token
+
+1. Log in to <https://id.atlassian.com/manage/api-tokens>.
+2. Click *Create API token*.
+3. From the dialog that appears, enter a memorable and concise *Label* for your token and click *Create*.
+4. Click *Copy to clipboard*, then paste the token to your script, or elsewhere to save.
+
+### Setting up the environment
+
+Confluence organization domain, base path, username, API token and space key can be specified at runtime or set as Confluence environment variables (e.g. add to your `~/.profile` on Linux, or `~/.bash_profile` or `~/.zshenv` on MacOS):
+
+```bash
+export CONFLUENCE_DOMAIN='instructure.atlassian.net'
+export CONFLUENCE_PATH='/wiki/'
+export CONFLUENCE_USER_NAME='levente.hunyadi@instructure.com'
+export CONFLUENCE_API_KEY='0123456789abcdef'
+export CONFLUENCE_SPACE_KEY='DAP'
+```
+
+On Windows, these can be set via system properties.
+
+### Permissions
+
+The tool requires appropriate permissions in Confluence in order to invoke endpoints.
+
+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.
+
+If you lack appropriate permissions, you will get an *Unauthorized* response from Confluence. The tool will emit a message that looks as follows:
+
+```
+2023-06-30 23:59:59,000 - ERROR - <module> [80] - 401 Client Error: Unauthorized for url: ...
+```
+
+### Associating a Markdown file with a wiki page
+
+Each Markdown file is associated with a Confluence wiki page with a Markdown comment:
+
+```markdown
+<!-- confluence-page-id: 85668266616 -->
+```
+
+The above tells the tool to synchronize the Markdown file with the given Confluence page ID. This implies that the Confluence wiki page must exist such that it has an ID. The comment can be placed anywhere in the source file.
+
+### Setting the Confluence space
+
+If you work in an environment where there are multiple Confluence spaces, and some Markdown pages may go into one space, whereas other pages may go into another, you can set the target space on a per-document basis:
+
+```markdown
+<!-- confluence-space-key: DAP -->
+```
+
+This overrides the default space set via command-line arguments or environment variables.
+
+### Setting generated-by prompt text for wiki pages
+
+In order to ensure readers are not editing a generated document, the tool adds a warning message at the top of the Confluence page as an *info panel*. You can customize the text that appears. The text can contain markup as per the [Confluence Storage Format](https://confluence.atlassian.com/doc/confluence-storage-format-790796544.html), and is emitted directly into the *info panel* macro.
+
+Provide generated-by prompt text in the Markdown file with a tag:
+
+```markdown
+<!-- generated-by: Do not edit! Check out the <a href="https://example.com/project">original source</a>. -->
+```
+
+Alternatively, use the `--generated-by GENERATED_BY` option. The tag takes precedence.
+
+### Running the tool
+
+You execute the command-line tool `md2conf` to synchronize the Markdown file with Confluence:
+
+```console
+$ python3 -m md2conf sample/example.md
+```
+
+Use the `--help` switch to get a full list of supported command-line options:
+
+```console
+$ python3 -m md2conf --help
+usage: md2conf [-h] [-d DOMAIN] [-p PATH] [-u USERNAME] [-a APIKEY] [-s SPACE] [-l {debug,info,warning,error,critical}] [-r ROOT_PAGE] [--generated-by GENERATED_BY]
+               [--no-generated-by] [--ignore-invalid-url] [--local]
+               mdpath
+
+positional arguments:
+  mdpath                Path to Markdown file or directory to convert and publish.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -d DOMAIN, --domain DOMAIN
+                        Confluence organization domain.
+  -p PATH, --path PATH  Base path for Confluence (default: '/wiki/').
+  -u USERNAME, --username USERNAME
+                        Confluence user name.
+  -a APIKEY, --apikey APIKEY
+                        Confluence API key. Refer to documentation how to obtain one.
+  -s SPACE, --space SPACE
+                        Confluence space key for pages to be published. If omitted, will default to user space.
+  -l {debug,info,warning,error,critical}, --loglevel {debug,info,warning,error,critical}
+                        Use this option to set the log verbosity.
+  -r ROOT_PAGE          Root Confluence page to create new pages. If omitted, will raise exception when creating new pages.
+  --generated-by GENERATED_BY
+                        Add prompt to pages (default: 'This page has been generated with a tool.').
+  --no-generated-by     Do not add 'generated by a tool' prompt to pages.
+  --ignore-invalid-url  Emit a warning but otherwise ignore relative URLs that point to ill-specified locations.
+  --local               Write XHTML-based Confluence Storage Format files locally without invoking Confluence API.
+```

markdown_to_confluence-0.1.13.dist-info/RECORD

@@ -0,0 +1,16 @@
+md2conf/__init__.py,sha256=yAKxptdEAiSXE55X3TxhUYa2iMkbW9fo1CWVRX8FNUY,416
+md2conf/__main__.py,sha256=-ZztZII6QYeuukxlOkVm8Mh9M1_ksA-5I2e2o5mvKLI,4353
+md2conf/api.py,sha256=ghLdaQtltRJ2-SUjhOZNkohL-RJ0Y1h6SfT7RiLPPZM,15231
+md2conf/application.py,sha256=BuIWLWrU8yaMbQhK0n3SUEPjxc7XJ0RIUdE3ALw9umE,5411
+md2conf/converter.py,sha256=_wfhDG-8Q3iAtR28Hp_ja-jyRMeb4HOvjCBsg1YMSZM,18926
+md2conf/entities.dtd,sha256=6and_fCiCHKhC7XXX0Fs-AaC0k_YN6csRQ7RiqbwyuM,30752
+md2conf/processor.py,sha256=TRsDbrNswNUjkdP7vXEUPYZvC07P6QN92ddwTGXVljg,3175
+md2conf/properties.py,sha256=zjtOQ73gQa5clPC6Ep4WHVjYIjTwPfrAtGDK7CUqbyc,1863
+md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+markdown_to_confluence-0.1.13.dist-info/LICENSE,sha256=d0Kt_fnS_LlDYrLPPI5xUSDGXRWRZNv81uKvmHa3lZM,1098
+markdown_to_confluence-0.1.13.dist-info/METADATA,sha256=NcsPNl4S4PsKF_lM8tbxNbOjdpf1Be3OFec9AmdJrSs,8035
+markdown_to_confluence-0.1.13.dist-info/WHEEL,sha256=nCVcAvsfA9TDtwGwhYaRrlPhTLV9m-Ga6mdyDtuwK18,91
+markdown_to_confluence-0.1.13.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
+markdown_to_confluence-0.1.13.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
+markdown_to_confluence-0.1.13.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+markdown_to_confluence-0.1.13.dist-info/RECORD,,

{markdown_to_confluence-0.1.11.dist-info → markdown_to_confluence-0.1.13.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (73.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

markdown_to_confluence-0.1.13.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+md2conf = md2conf.__main__:main

{markdown_to_confluence-0.1.11.dist-info → markdown_to_confluence-0.1.13.dist-info}/zip-safe

@@ -1 +1 @@
-
+

md2conf/__init__.py

@@ -1,13 +1,13 @@
-"""
-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.
-"""
-
-__version__ = "0.1.11"
-__author__ = "Levente Hunyadi"
-__copyright__ = "Copyright 2022-2024, Levente Hunyadi"
-__license__ = "MIT"
-__maintainer__ = "Levente Hunyadi"
-__status__ = "Production"
+"""
+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.
+"""
+
+__version__ = "0.1.13"
+__author__ = "Levente Hunyadi"
+__copyright__ = "Copyright 2022-2024, Levente Hunyadi"
+__license__ = "MIT"
+__maintainer__ = "Levente Hunyadi"
+__status__ = "Production"