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

md2conf/__main__.py

@@ -1,129 +1,139 @@
-import argparse
-import logging
-import os.path
-import sys
-import typing
-from typing import Optional
-
-import requests
-
-from .api import ConfluenceAPI
-from .application import Application
-from .converter import ConfluenceDocumentOptions
-from .processor import Processor
-from .properties import ConfluenceProperties
-
-
-class Arguments(argparse.Namespace):
-    mdpath: str
-    domain: str
-    path: str
-    username: str
-    apikey: str
-    space: str
-    loglevel: str
-    ignore_invalid_url: bool
-    generated_by: Optional[str]
-
-
-parser = argparse.ArgumentParser()
-parser.prog = os.path.basename(os.path.dirname(__file__))
-parser.add_argument(
-    "mdpath", help="Path to Markdown file or directory to convert and publish."
-)
-parser.add_argument("-d", "--domain", help="Confluence organization domain.")
-parser.add_argument("-p", "--path", help="Base path for Confluece wiki.")
-parser.add_argument("-u", "--username", help="Confluence user name.")
-parser.add_argument(
-    "-a",
-    "--apikey",
-    help="Confluence API key. Refer to documentation how to obtain one.",
-)
-parser.add_argument(
-    "-s",
-    "--space",
-    help="Confluence space key for pages to be published. If omitted, will default to user space.",
-)
-parser.add_argument(
-    "-l",
-    "--loglevel",
-    choices=[
-        typing.cast(str, logging.getLevelName(level)).lower()
-        for level in (
-            logging.DEBUG,
-            logging.INFO,
-            logging.WARN,
-            logging.ERROR,
-            logging.CRITICAL,
-        )
-    ],
-    default=logging.getLevelName(logging.INFO),
-    help="Use this option to set the log verbosity.",
-)
-parser.add_argument(
-    "-r",
-    dest="root_page",
-    help="Root Confluence page to create new pages. If omitted, will raise exception when creating new pages.",
-)
-parser.add_argument(
-    "--generated-by",
-    default="This page has been generated with a tool.",
-    help="Add prompt to pages (default: 'This page has been generated with a tool.').",
-)
-parser.add_argument(
-    "--no-generated-by",
-    dest="generated_by",
-    action="store_const",
-    const=None,
-    help="Do not add 'generated by a tool' prompt to pages.",
-)
-parser.add_argument(
-    "--ignore-invalid-url",
-    action="store_true",
-    default=False,
-    help="Emit a warning but otherwise ignore relative URLs that point to ill-specified locations.",
-)
-parser.add_argument(
-    "--local",
-    action="store_true",
-    default=False,
-    help="Write XHTML-based Confluence Storage Format files locally without invoking Confluence API.",
-)
-
-args = Arguments()
-parser.parse_args(namespace=args)
-
-logging.basicConfig(
-    level=getattr(logging, args.loglevel.upper(), logging.INFO),
-    format="%(asctime)s - %(levelname)s - %(funcName)s [%(lineno)d] - %(message)s",
-)
-
-
-options = ConfluenceDocumentOptions(
-    ignore_invalid_url=args.ignore_invalid_url,
-    generated_by=args.generated_by,
-    root_page_id=args.root_page,
-)
-properties = ConfluenceProperties(
-    args.domain, args.path, args.username, args.apikey, args.space
-)
-if args.local:
-    Processor(options, properties).process(args.mdpath)
-else:
-    try:
-        with ConfluenceAPI(properties) as api:
-            Application(
-                api,
-                options,
-            ).synchronize(args.mdpath)
-    except requests.exceptions.HTTPError as err:
-        logging.error(err)
-
-        # print details for a response with JSON body
-        if err.response is not None:
-            try:
-                logging.error(err.response.json())
-            except requests.exceptions.JSONDecodeError:
-                pass
-
-        sys.exit(1)
+import argparse
+import logging
+import os.path
+import sys
+from pathlib import Path
+from typing import Optional
+
+import requests
+
+from .api import ConfluenceAPI
+from .application import Application
+from .converter import ConfluenceDocumentOptions
+from .processor import Processor
+from .properties import ConfluenceProperties
+
+
+class Arguments(argparse.Namespace):
+    mdpath: Path
+    domain: str
+    path: str
+    username: str
+    apikey: str
+    space: str
+    loglevel: str
+    ignore_invalid_url: bool
+    generated_by: Optional[str]
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser()
+    parser.prog = os.path.basename(os.path.dirname(__file__))
+    parser.add_argument(
+        "mdpath", help="Path to Markdown file or directory to convert and publish."
+    )
+    parser.add_argument("-d", "--domain", help="Confluence organization domain.")
+    parser.add_argument(
+        "-p", "--path", help="Base path for Confluence (default: '/wiki/')."
+    )
+    parser.add_argument("-u", "--username", help="Confluence user name.")
+    parser.add_argument(
+        "-a",
+        "--apikey",
+        help="Confluence API key. Refer to documentation how to obtain one.",
+    )
+    parser.add_argument(
+        "-s",
+        "--space",
+        help="Confluence space key for pages to be published. If omitted, will default to user space.",
+    )
+    parser.add_argument(
+        "-l",
+        "--loglevel",
+        choices=[
+            logging.getLevelName(level).lower()
+            for level in (
+                logging.DEBUG,
+                logging.INFO,
+                logging.WARN,
+                logging.ERROR,
+                logging.CRITICAL,
+            )
+        ],
+        default=logging.getLevelName(logging.INFO),
+        help="Use this option to set the log verbosity.",
+    )
+    parser.add_argument(
+        "-r",
+        dest="root_page",
+        help="Root Confluence page to create new pages. If omitted, will raise exception when creating new pages.",
+    )
+    parser.add_argument(
+        "--generated-by",
+        default="This page has been generated with a tool.",
+        help="Add prompt to pages (default: 'This page has been generated with a tool.').",
+    )
+    parser.add_argument(
+        "--no-generated-by",
+        dest="generated_by",
+        action="store_const",
+        const=None,
+        help="Do not add 'generated by a tool' prompt to pages.",
+    )
+    parser.add_argument(
+        "--ignore-invalid-url",
+        action="store_true",
+        default=False,
+        help="Emit a warning but otherwise ignore relative URLs that point to ill-specified locations.",
+    )
+    parser.add_argument(
+        "--local",
+        action="store_true",
+        default=False,
+        help="Write XHTML-based Confluence Storage Format files locally without invoking Confluence API.",
+    )
+
+    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(
+        level=getattr(logging, args.loglevel.upper(), logging.INFO),
+        format="%(asctime)s - %(levelname)s - %(funcName)s [%(lineno)d] - %(message)s",
+    )
+
+    options = ConfluenceDocumentOptions(
+        ignore_invalid_url=args.ignore_invalid_url,
+        generated_by=args.generated_by,
+        root_page_id=args.root_page,
+    )
+    properties = ConfluenceProperties(
+        args.domain, args.path, args.username, args.apikey, args.space
+    )
+    if args.local:
+        Processor(options, properties).process(args.mdpath)
+    else:
+        try:
+            with ConfluenceAPI(properties) as api:
+                Application(
+                    api,
+                    options,
+                ).synchronize(args.mdpath)
+        except requests.exceptions.HTTPError as err:
+            logging.error(err)
+
+            # print details for a response with JSON body
+            if err.response is not None:
+                try:
+                    logging.error(err.response.json())
+                except requests.exceptions.JSONDecodeError:
+                    pass
+
+            sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()