markdown-to-confluence 0.1.4__tar.gz → 0.1.6__tar.gz

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Levente Hunyadi
+Copyright (c) 2022-2023 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

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/PKG-INFO

@@ -1,18 +1,23 @@
 Metadata-Version: 2.1
 Name: markdown-to-confluence
-Version: 0.1.4
+Version: 0.1.6
 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: Typing :: Typed
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -39,7 +44,7 @@ This Python package
 ## Getting started
 
 In order to get started, you will need
-* your organization URL (e.g. `https://instructure.atlassian.net`),
+* your organization domain name (e.g. `instructure.atlassian.net`),
 * your Confluence username (e.g. `levente.hunyadi@instructure.com`),
 * a Confluence API token (a string of alphanumeric characters), and
 * the space key in Confluence (e.g. `DAP`) you are publishing content to.

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/README.md

@@ -21,7 +21,7 @@ This Python package
 ## Getting started
 
 In order to get started, you will need
-* your organization URL (e.g. `https://instructure.atlassian.net`),
+* your organization domain name (e.g. `instructure.atlassian.net`),
 * your Confluence username (e.g. `levente.hunyadi@instructure.com`),
 * a Confluence API token (a string of alphanumeric characters), and
 * the space key in Confluence (e.g. `DAP`) you are publishing content to.

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/markdown_to_confluence.egg-info/PKG-INFO

@@ -1,18 +1,23 @@
 Metadata-Version: 2.1
 Name: markdown-to-confluence
-Version: 0.1.4
+Version: 0.1.6
 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: Typing :: Typed
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -39,7 +44,7 @@ This Python package
 ## Getting started
 
 In order to get started, you will need
-* your organization URL (e.g. `https://instructure.atlassian.net`),
+* your organization domain name (e.g. `instructure.atlassian.net`),
 * your Confluence username (e.g. `levente.hunyadi@instructure.com`),
 * a Confluence API token (a string of alphanumeric characters), and
 * the space key in Confluence (e.g. `DAP`) you are publishing content to.

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/markdown_to_confluence.egg-info/SOURCES.txt

@@ -13,4 +13,6 @@ md2conf/__init__.py
 md2conf/__main__.py
 md2conf/api.py
 md2conf/application.py
-md2conf/converter.py
+md2conf/converter.py
+md2conf/py.typed
+tests/test_api.py

markdown-to-confluence-0.1.6/markdown_to_confluence.egg-info/requires.txt

@@ -0,0 +1,6 @@
+lxml>=4.9
+markdown>=3.4
+pymdown-extensions>=9.11
+requests>=2.28
+types-markdown>=3.4
+types-requests>=2.28

markdown-to-confluence-0.1.6/md2conf/__init__.py

@@ -0,0 +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.6"
+__author__ = "Levente Hunyadi"
+__copyright__ = "Copyright 2022-2023, Levente Hunyadi"
+__license__ = "MIT"
+__maintainer__ = "Levente Hunyadi"
+__status__ = "Production"

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/md2conf/__main__.py

@@ -1,9 +1,13 @@
 import argparse
 import logging
 import os.path
+import sys
+
+import requests
 
 from .api import ConfluenceAPI
 from .application import synchronize_page
+from .converter import ConfluenceDocumentOptions
 
 
 class Arguments(argparse.Namespace):
@@ -13,6 +17,7 @@ class Arguments(argparse.Namespace):
     apikey: str
     space: str
     loglevel: str
+    generated_by: bool
 
 
 parser = argparse.ArgumentParser()
@@ -46,6 +51,18 @@ parser.add_argument(
     default=logging.getLevelName(logging.INFO),
     help="Use this option to set the log verbosity.",
 )
+parser.add_argument(
+    "--generated-by",
+    action="store_true",
+    help="Add 'generated by a tool' prompt to pages.",
+)
+parser.add_argument(
+    "--no-generated-by",
+    dest="generated_by",
+    action="store_false",
+    help="Do not add 'generated by a tool' prompt to pages.",
+)
+parser.set_defaults(generated_by=True)
 
 args = Arguments()
 parser.parse_args(namespace=args)
@@ -55,5 +72,17 @@ logging.basicConfig(
     format="%(asctime)s - %(levelname)s - %(funcName)s [%(lineno)d] - %(message)s",
 )
 
-with ConfluenceAPI(args.domain, args.username, args.apikey, args.space) as api:
-    synchronize_page(api, args.mdfile)
+try:
+    with ConfluenceAPI(args.domain, args.username, args.apikey, args.space) as api:
+        synchronize_page(api, args.mdfile, ConfluenceDocumentOptions(args.generated_by))
+except requests.exceptions.HTTPError as err:
+    logging.error(err)
+
+    # print details for a response with JSON body
+    try:
+        response: requests.Response = err.response
+        logging.error(response.json())
+    except requests.exceptions.JSONDecodeError:
+        pass
+
+    sys.exit(1)

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/md2conf/api.py

@@ -3,20 +3,34 @@ import logging
 import mimetypes
 import os
 import os.path
-import urllib.parse
+import sys
+import typing
 from contextlib import contextmanager
 from dataclasses import dataclass
-from typing import Dict, Generator
+from types import TracebackType
+from typing import Dict, Generator, List, Optional, Type, Union
+from urllib.parse import urlencode, urlparse, urlunparse
 
 import requests
 
 from .converter import ParseError, sanitize_confluence
 
+# a JSON type with possible `null` values
+JsonType = Union[
+    None,
+    bool,
+    int,
+    float,
+    str,
+    Dict[str, "JsonType"],
+    List["JsonType"],
+]
 
-def build_url(base_url: str, query: Dict[str, str] = None):
+
+def build_url(base_url: str, query: Optional[Dict[str, str]] = None) -> str:
     "Builds a URL with scheme, host, port, path and query string parameters."
 
-    scheme, netloc, path, params, query_str, fragment = urllib.parse.urlparse(base_url)
+    scheme, netloc, path, params, query_str, fragment = urlparse(base_url)
 
     if params:
         raise ValueError("expected: url with no parameters")
@@ -25,9 +39,26 @@ def build_url(base_url: str, query: Dict[str, str] = None):
     if fragment:
         raise ValueError("expected: url with no fragment")
 
-    query_str = urllib.parse.urlencode(query) if query else None
-    url_parts = (scheme, netloc, path, None, query_str, None)
-    return urllib.parse.urlunparse(url_parts)
+    url_parts = (scheme, netloc, path, None, urlencode(query) if query else None, None)
+    return urlunparse(url_parts)
+
+
+if sys.version_info >= (3, 9):
+
+    def removeprefix(string: str, prefix: str) -> str:
+        "If the string starts with the prefix, return the string without the prefix; otherwise, return the original string."
+
+        return string.removeprefix(prefix)
+
+else:
+
+    def removeprefix(string: str, prefix: str) -> str:
+        "If the string starts with the prefix, return the string without the prefix; otherwise, return the original string."
+
+        if string.startswith(prefix):
+            return string[len(prefix) :]
+        else:
+            return string
 
 
 LOGGER = logging.getLogger(__name__)
@@ -59,36 +90,54 @@ class ConfluenceAPI:
     user_name: str
     api_key: str
 
-    session: "ConfluenceSession"
+    session: Optional["ConfluenceSession"] = None
 
     def __init__(
         self,
-        domain: str = None,
-        user_name: str = None,
-        api_key: str = None,
-        space_key: str = None,
+        domain: Optional[str] = None,
+        user_name: Optional[str] = None,
+        api_key: Optional[str] = None,
+        space_key: Optional[str] = None,
     ) -> None:
-        self.domain = domain or os.getenv("CONFLUENCE_DOMAIN")
-        self.user_name = user_name or os.getenv("CONFLUENCE_USER_NAME")
-        self.api_key = api_key or os.getenv("CONFLUENCE_API_KEY")
-        self.space_key = space_key or os.getenv("CONFLUENCE_SPACE_KEY")
+        opt_domain = domain or os.getenv("CONFLUENCE_DOMAIN")
+        opt_user_name = user_name or os.getenv("CONFLUENCE_USER_NAME")
+        opt_api_key = api_key or os.getenv("CONFLUENCE_API_KEY")
+        opt_space_key = space_key or os.getenv("CONFLUENCE_SPACE_KEY")
 
-        if not self.domain:
+        if not opt_domain:
             raise ConfluenceError("Confluence domain not specified")
-        if not self.user_name:
+        if not opt_user_name:
             raise ConfluenceError("Confluence user name not specified")
-        if not self.api_key:
+        if not opt_api_key:
             raise ConfluenceError("Confluence API key not specified")
+        if not opt_space_key:
+            raise ConfluenceError("Confluence space key not specified")
 
-    def __enter__(self):
+        if opt_domain.startswith(("http://", "https://")):
+            raise ConfluenceError(
+                "Confluence domain looks like a URL; only host name required"
+            )
+
+        self.domain = opt_domain
+        self.user_name = opt_user_name
+        self.api_key = opt_api_key
+        self.space_key = opt_space_key
+
+    def __enter__(self) -> "ConfluenceSession":
         session = requests.Session()
         session.auth = (self.user_name, self.api_key)
         self.session = ConfluenceSession(session, self.domain, self.space_key)
         return self.session
 
-    def __exit__(self, type, value, traceback):
-        self.session.close()
-        self.session = None
+    def __exit__(
+        self,
+        exc_type: Optional[Type[BaseException]],
+        exc_val: Optional[BaseException],
+        exc_tb: Optional[TracebackType],
+    ) -> None:
+        if self.session is not None:
+            self.session.close()
+            self.session = None
 
 
 class ConfluenceSession:
@@ -113,11 +162,11 @@ class ConfluenceSession:
         finally:
             self.space_key = old_space_key
 
-    def _build_url(self, path: str, query: Dict[str, str] = None) -> str:
+    def _build_url(self, path: str, query: Optional[Dict[str, str]] = None) -> str:
         base_url = f"https://{self.domain}/wiki/rest/api{path}"
         return build_url(base_url, query)
 
-    def _invoke(self, path: str, query: Dict[str, str]) -> str:
+    def _invoke(self, path: str, query: Dict[str, str]) -> JsonType:
         url = self._build_url(path, query)
         response = self.session.get(url)
         response.raise_for_status()
@@ -137,17 +186,18 @@ class ConfluenceSession:
     ) -> ConfluenceAttachment:
         path = f"/content/{page_id}/child/attachment"
         query = {"spaceKey": self.space_key, "filename": filename}
-        data = self._invoke(path, query)
+        data = typing.cast(Dict[str, JsonType], self._invoke(path, query))
 
-        results = data["results"]
+        results = typing.cast(List[JsonType], data["results"])
         if len(results) != 1:
             raise ConfluenceError(f"no such attachment on page {page_id}: {filename}")
+        result = typing.cast(Dict[str, JsonType], results[0])
 
-        id = results[0]["id"]
-        extensions = results[0]["extensions"]
-        media_type = extensions["mediaType"]
-        file_size = extensions["fileSize"]
-        comment = extensions["comment"]
+        id = typing.cast(str, result["id"])
+        extensions = typing.cast(Dict[str, JsonType], result["extensions"])
+        media_type = typing.cast(str, extensions["mediaType"])
+        file_size = typing.cast(int, extensions["fileSize"])
+        comment = typing.cast(str, extensions["comment"])
         return ConfluenceAttachment(id, media_type, file_size, comment)
 
     def upload_attachment(
@@ -155,9 +205,8 @@ class ConfluenceSession:
         page_id: str,
         attachment_path: str,
         attachment_name: str,
-        comment: str = None,
+        comment: Optional[str] = None,
     ) -> None:
-
         content_type = mimetypes.guess_type(attachment_path, strict=True)[0]
 
         if not os.path.isfile(attachment_path):
@@ -170,7 +219,7 @@ class ConfluenceSession:
                 LOGGER.info("Up-to-date attachment: %s", attachment_name)
                 return
 
-            id = attachment.id.removeprefix("att")
+            id = removeprefix(attachment.id, "att")
             path = f"/content/{page_id}/child/attachment/{id}/data"
 
         except ConfluenceError:
@@ -190,7 +239,9 @@ class ConfluenceSession:
             }
             LOGGER.info("Uploading attachment: %s", attachment_name)
             response = self.session.post(
-                url, files=file_to_upload, headers={"X-Atlassian-Token": "no-check"}
+                url,
+                files=file_to_upload,  # type: ignore
+                headers={"X-Atlassian-Token": "no-check"},
             )
 
         response.raise_for_status()
@@ -210,8 +261,7 @@ class ConfluenceSession:
     def _update_attachment(
         self, page_id: str, attachment_id: str, version: int, attachment_title: str
     ) -> None:
-
-        id = attachment_id.removeprefix("att")
+        id = removeprefix(attachment_id, "att")
         path = f"/content/{page_id}/child/attachment/{id}"
         data = {
             "id": attachment_id,
@@ -236,13 +286,14 @@ class ConfluenceSession:
         LOGGER.info("Looking up page with title: %s", title)
         path = "/content"
         query = {"title": title, "spaceKey": self.space_key}
-        data = self._invoke(path, query)
+        data = typing.cast(Dict[str, JsonType], self._invoke(path, query))
 
-        results = data["results"]
+        results = typing.cast(List[JsonType], data["results"])
         if len(results) != 1:
             raise ConfluenceError(f"page not found with title: {title}")
 
-        id = results[0]["id"]
+        result = typing.cast(Dict[str, JsonType], results[0])
+        id = typing.cast(str, result["id"])
         return id
 
     def get_page(self, page_id: str) -> ConfluencePage:
@@ -251,13 +302,16 @@ class ConfluenceSession:
             "spaceKey": self.space_key,
             "expand": "body.storage,version",
         }
-        data = self._invoke(path, query)
+        data = typing.cast(Dict[str, JsonType], self._invoke(path, query))
+        version = typing.cast(Dict[str, JsonType], data["version"])
+        body = typing.cast(Dict[str, JsonType], data["body"])
+        storage = typing.cast(Dict[str, JsonType], body["storage"])
 
         return ConfluencePage(
             id=page_id,
-            title=data["title"],
-            version=data["version"]["number"],
-            content=data["body"]["storage"]["value"],
+            title=typing.cast(str, data["title"]),
+            version=typing.cast(int, version["number"]),
+            content=typing.cast(str, storage["value"]),
         )
 
     def get_page_version(self, page_id: str) -> int:
@@ -266,8 +320,9 @@ class ConfluenceSession:
             "spaceKey": self.space_key,
             "expand": "version",
         }
-        data = self._invoke(path, query)
-        return data["version"]["number"]
+        data = typing.cast(Dict[str, JsonType], self._invoke(path, query))
+        version = typing.cast(Dict[str, JsonType], data["version"])
+        return typing.cast(int, version["number"])
 
     def update_page(self, page_id: str, new_content: str) -> None:
         page = self.get_page(page_id)
@@ -277,8 +332,8 @@ class ConfluenceSession:
             if old_content == new_content:
                 LOGGER.info("Up-to-date page: %s", page_id)
                 return
-        except ParseError:
-            pass
+        except ParseError as exc:
+            LOGGER.warning(exc)
 
         path = f"/content/{page_id}"
         data = {

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/md2conf/application.py

@@ -1,7 +1,7 @@
 import os.path
 
 from .api import ConfluenceSession
-from .converter import ConfluenceDocument, markdown_to_html
+from .converter import ConfluenceDocument, ConfluenceDocumentOptions
 
 
 def update_document(
@@ -15,11 +15,13 @@ def update_document(
     api.update_page(document.page_id, document.xhtml())
 
 
-def synchronize_page(api: ConfluenceSession, path: str) -> None:
+def synchronize_page(
+    api: ConfluenceSession, path: str, options: ConfluenceDocumentOptions
+) -> None:
     page_path = os.path.abspath(path)
     base_path = os.path.dirname(page_path)
 
-    document = ConfluenceDocument(path)
+    document = ConfluenceDocument(path, options)
 
     if document.space_key:
         with api.switch_space(document.space_key):

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/md2conf/converter.py

@@ -1,5 +1,6 @@
 import os.path
 import re
+from dataclasses import dataclass
 from typing import List, Optional, Tuple
 from urllib.parse import urlparse
 
@@ -24,7 +25,7 @@ class ParseError(RuntimeError):
     pass
 
 
-def is_absolute_url(url):
+def is_absolute_url(url: str) -> bool:
     return bool(urlparse(url).netloc)
 
 
@@ -153,7 +154,11 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
     def _transform_block(self, code: ET.Element) -> ET.Element:
         language = code.attrib.get("class")
         if language:
-            language = re.match("^language-(.*)$", language).group(1)
+            m = re.match("^language-(.*)$", language)
+            if m:
+                language = m.group(1)
+            else:
+                language = "none"
         if language not in _languages:
             language = "none"
         content: str = code.text
@@ -175,11 +180,11 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
     def transform(self, child: ET.Element) -> Optional[ET.Element]:
         # normalize line breaks to regular space in element text
         if child.text:
-            s: str = child.text
-            child.text = s.replace("\n", " ")
+            text: str = child.text
+            child.text = text.replace("\n", " ")
         if child.tail:
-            s: str = child.tail
-            child.tail = s.replace("\n", " ")
+            tail: str = child.tail
+            child.tail = tail.replace("\n", " ")
 
         # <p><img src="..." /></p>
         if child.tag == "p" and len(child) == 1 and child[0].tag == "img":
@@ -197,6 +202,8 @@ class ConfluenceStorageFormatConverter(NodeVisitor):
         elif child.tag == "pre" and len(child) == 1 and child[0].tag == "code":
             return self._transform_block(child[0])
 
+        return None
+
 
 class ConfluenceStorageFormatCleaner(NodeVisitor):
     "Removes volatile attributes from a Confluence storage format XHTML document."
@@ -204,13 +211,14 @@ class ConfluenceStorageFormatCleaner(NodeVisitor):
     def transform(self, child: ET.Element) -> Optional[ET.Element]:
         child.attrib.pop(ET.QName(namespaces["ac"], "macro-id"), None)
         child.attrib.pop(ET.QName(namespaces["ri"], "version-at-save"), None)
+        return None
 
 
 class DocumentError(RuntimeError):
     pass
 
 
-def _extract_value(pattern, string) -> Tuple[Optional[str], str]:
+def _extract_value(pattern: str, string: str) -> Tuple[Optional[str], str]:
     values: List[str] = []
 
     def _repl_func(matchobj: re.Match) -> str:
@@ -222,15 +230,29 @@ def _extract_value(pattern, string) -> Tuple[Optional[str], str]:
     return value, string
 
 
+@dataclass
+class ConfluenceDocumentOptions:
+    """
+    Options that control the generated page content.
+
+    :param show_generated: Whether to display a prompt "This page has been generated with a tool."
+    """
+
+    generated_by: bool = True
+
+
 class ConfluenceDocument:
     page_id: str
     space_key: Optional[str] = None
     links: List[str]
     images: List[str]
 
+    options: ConfluenceDocumentOptions
     root: ET.Element
 
-    def __init__(self, path: str) -> None:
+    def __init__(self, path: str, options: ConfluenceDocumentOptions) -> None:
+        self.options = options
+
         path = os.path.abspath(path)
 
         with open(path, "r") as f:
@@ -252,14 +274,16 @@ class ConfluenceDocument:
         )
 
         # parse Markdown document
-        self.root = elements_from_strings(
-            [
+        if self.options.generated_by:
+            content = [
                 '<ac:structured-macro ac:name="info" ac:schema-version="1">',
                 "<ac:rich-text-body><p>This page has been generated with a tool.</p></ac:rich-text-body>",
                 "</ac:structured-macro>",
                 html,
             ]
-        )
+        else:
+            content = [html]
+        self.root = elements_from_strings(content)
 
         converter = ConfluenceStorageFormatConverter(os.path.dirname(path))
         converter.visit(self.root)
@@ -273,6 +297,9 @@ class ConfluenceDocument:
 def sanitize_confluence(html: str) -> str:
     "Generates a sanitized version of a Confluence storage format XHTML document with no volatile attributes."
 
+    if not html:
+        return ""
+
     root = elements_from_strings([html])
     ConfluenceStorageFormatCleaner().visit(root)
     return _content_to_string(root)
@@ -281,4 +308,7 @@ def sanitize_confluence(html: str) -> str:
 def _content_to_string(root: ET.Element) -> str:
     xml = ET.tostring(root, encoding="utf8", method="xml").decode("utf8")
     m = re.match(r"^<root\s+[^>]*>(.*)</root>\s*$", xml, re.DOTALL)
-    return m.group(1)
+    if m:
+        return m.group(1)
+    else:
+        raise ValueError("expected: Confluence content")

{markdown-to-confluence-0.1.4 → markdown-to-confluence-0.1.6}/setup.cfg

@@ -9,28 +9,39 @@ long_description = file: README.md
 long_description_content_type = text/markdown
 license = MIT
 classifiers = 
+	Development Status :: 5 - Production/Stable
 	Environment :: Console
+	Intended Audience :: End Users/Desktop
 	License :: OSI Approved :: MIT License
 	Operating System :: OS Independent
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3.8
 	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	Typing :: Typed
 
 [options]
 zip_safe = True
 include_package_data = True
 packages = find:
+python_requires = >=3.8
 install_requires = 
-	lxml
-	markdown
-	pymdown-extensions
-	requests
+	lxml >= 4.9
+	markdown >= 3.4
+	pymdown-extensions >= 9.11
+	requests >= 2.28
+	types-markdown >= 3.4
+	types-requests >= 2.28
 
 [options.packages.find]
 exclude = 
 	tests*
 
+[options.package_data]
+md2conf = 
+	py.typed
+
 [egg_info]
 tag_build = 
 tag_date = 0

markdown-to-confluence-0.1.6/tests/test_api.py

@@ -0,0 +1,73 @@
+import logging
+import os
+import os.path
+import unittest
+
+from md2conf.api import ConfluenceAPI, ConfluenceAttachment, ConfluencePage
+from md2conf.application import synchronize_page
+from md2conf.converter import (
+    ConfluenceDocument,
+    ConfluenceDocumentOptions,
+    sanitize_confluence,
+)
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s - %(levelname)s - %(funcName)s [%(lineno)d] - %(message)s",
+)
+
+
+class TestAPI(unittest.TestCase):
+    def test_markdown(self) -> None:
+        document = ConfluenceDocument("example.md", ConfluenceDocumentOptions())
+        self.assertListEqual(document.links, [])
+        self.assertListEqual(
+            document.images,
+            ["figure/interoperability.png", "figure/interoperability.png"],
+        )
+
+        with open(os.path.join("tests", "output", "document.html"), "w") as f:
+            f.write(document.xhtml())
+
+    def test_find_page_by_title(self) -> None:
+        with ConfluenceAPI() as api:
+            id = api.get_page_id_by_title("Publish to Confluence")
+            self.assertEqual(id, "85668266616")
+
+    def test_switch_space(self) -> None:
+        with ConfluenceAPI(space_key="PLAT") as api:
+            with api.switch_space("DAP"):
+                id = api.get_page_id_by_title("Publish to Confluence")
+                self.assertEqual(id, "85668266616")
+
+    def test_get_page(self) -> None:
+        with ConfluenceAPI() as api:
+            page = api.get_page("85668266616")
+            self.assertIsInstance(page, ConfluencePage)
+
+        with open(os.path.join("tests", "output", "page.html"), "w") as f:
+            f.write(sanitize_confluence(page.content))
+
+    def test_get_attachment(self) -> None:
+        with ConfluenceAPI() as api:
+            data = api.get_attachment_by_name(
+                "85668266616", "figure/interoperability.png"
+            )
+            self.assertIsInstance(data, ConfluenceAttachment)
+
+    def test_upload_attachment(self) -> None:
+        with ConfluenceAPI() as api:
+            api.upload_attachment(
+                "85668266616",
+                os.path.join(os.getcwd(), "figure", "interoperability.png"),
+                "figure/interoperability.png",
+                "A sample figure",
+            )
+
+    def test_synchronize_page(self) -> None:
+        with ConfluenceAPI() as api:
+            synchronize_page(api, "example.md", ConfluenceDocumentOptions())
+
+
+if __name__ == "__main__":
+    unittest.main()

markdown-to-confluence-0.1.4/markdown_to_confluence.egg-info/requires.txt

@@ -1,4 +0,0 @@
-lxml
-markdown
-pymdown-extensions
-requests

markdown-to-confluence-0.1.4/md2conf/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.4"