kci-confluence-cli 0.1.0__tar.gz

kci_confluence_cli-0.1.0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.1
+Name: kci-confluence-cli
+Version: 0.1.0
+Summary: 来栖川電算が利用しているConfluence v6.15.7を操作するためのCLIです。
+Home-page: https://github.com/kurusugawa-computer/confluence-cli
+License: MIT
+Author: Kurusugawa Computer Inc.
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+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: Topic :: Utilities
+Requires-Dist: backoff
+Requires-Dist: more_itertools
+Requires-Dist: pyquery (>=2,<3)
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: requests-toolbelt (>=1,<2)
+Project-URL: Repository, https://github.com/kurusugawa-computer/confluence-cli
+Description-Content-Type: text/markdown
+
+# confluence-cli
+来栖川電算が利用しているConfluence v6.15.7を操作するためのCLIです。
+
+# Requirements
+Python 3.9+
+
+# Install
+
+```
+$ pip install kci-confluence-cli
+```
+
+# 使い方
+
+## 認証情報の指定
+以下のいずれかの方法で指定できます。
+
+* 環境変数 `CONFLUENCE_USER_NAME` , `CONFLUENCE_USER_PASSWORD` に指定する
+* コマンドライン引数 `--confluence_user_name` , `--confluence_user_password`に指定する
+
+上記の方法で認証情報が指定されない場合は、標準入力から認証情報を入力できます。
+
+
+## ConfluenceのURLの指定
+アクセスするConfluenceのURLを、以下のいずれかの方法で指定できます。
+
+* 環境変数 `CONFLUENCE_BASE_URL`に指定する
+* コマンドライン引数 `--confluence_base_url`に指定する
+
+上記の方法で指定されない場合は、標準入力から入力できます。
+
+来栖川電算のConfluneceにアクセスする場合は、`https://kurusugawa.jp/confluence`を指定してください。
+
+
+# Command Reference
+### attachment get
+添付ファイル情報の取得
+
+
+### attachment create
+添付ファイルの作成
+
+
+### attachment delete
+添付ファイルを削除します。
+
+※添付ファイルをゴミ箱から完全に削除すると、ページを更新できない場合があります。その場合は、一時的に前のバージョンに戻せば、ページを更新できるようになります。
+https://qiita.com/yuji38kwmt/items/c88f039e02b8508926e6
+
+
+### attachment get
+コンテンツ（ページやブログ、添付ファイルなど）の情報を取得します。
+
+### local convert_html
+HTMLをConfluence用のXMLに変換します。
+Google DocsのページをConfluenceに移行するときなどに利用できます。
+具体的な手順は以下を参照してください。
+https://github.com/kurusugawa-computer/confluence-cli/wiki/Google-Docs%E3%82%92Confluence%E3%81%AB%E7%A7%BB%E8%A1%8C%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95
+

kci_confluence_cli-0.1.0/README.md

@@ -0,0 +1,58 @@
+# confluence-cli
+来栖川電算が利用しているConfluence v6.15.7を操作するためのCLIです。
+
+# Requirements
+Python 3.9+
+
+# Install
+
+```
+$ pip install kci-confluence-cli
+```
+
+# 使い方
+
+## 認証情報の指定
+以下のいずれかの方法で指定できます。
+
+* 環境変数 `CONFLUENCE_USER_NAME` , `CONFLUENCE_USER_PASSWORD` に指定する
+* コマンドライン引数 `--confluence_user_name` , `--confluence_user_password`に指定する
+
+上記の方法で認証情報が指定されない場合は、標準入力から認証情報を入力できます。
+
+
+## ConfluenceのURLの指定
+アクセスするConfluenceのURLを、以下のいずれかの方法で指定できます。
+
+* 環境変数 `CONFLUENCE_BASE_URL`に指定する
+* コマンドライン引数 `--confluence_base_url`に指定する
+
+上記の方法で指定されない場合は、標準入力から入力できます。
+
+来栖川電算のConfluneceにアクセスする場合は、`https://kurusugawa.jp/confluence`を指定してください。
+
+
+# Command Reference
+### attachment get
+添付ファイル情報の取得
+
+
+### attachment create
+添付ファイルの作成
+
+
+### attachment delete
+添付ファイルを削除します。
+
+※添付ファイルをゴミ箱から完全に削除すると、ページを更新できない場合があります。その場合は、一時的に前のバージョンに戻せば、ページを更新できるようになります。
+https://qiita.com/yuji38kwmt/items/c88f039e02b8508926e6
+
+
+### attachment get
+コンテンツ（ページやブログ、添付ファイルなど）の情報を取得します。
+
+### local convert_html
+HTMLをConfluence用のXMLに変換します。
+Google DocsのページをConfluenceに移行するときなどに利用できます。
+具体的な手順は以下を参照してください。
+https://github.com/kurusugawa-computer/confluence-cli/wiki/Google-Docs%E3%82%92Confluence%E3%81%AB%E7%A7%BB%E8%A1%8C%E3%81%99%E3%82%8B%E6%96%B9%E6%B3%95

kci_confluence_cli-0.1.0/confluence/__init__.py

@@ -0,0 +1,5 @@
+from .__version__ import __version__
+
+__all__ = [
+    "__version__",
+]

kci_confluence_cli-0.1.0/confluence/__main__.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+import argparse
+import logging
+from collections.abc import Sequence
+from typing import Optional
+
+import confluence
+import confluence.attachment.subcommand
+import confluence.content.subcommand
+import confluence.local.subcommand
+import confluence.page.subcommand
+from confluence.common.cli import PrettyHelpFormatter
+from confluence.common.utils import set_logger
+
+logger = logging.getLogger(__name__)
+
+
+def create_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(description="Command Line Interface for Confluence", formatter_class=PrettyHelpFormatter, allow_abbrev=False)
+    parser.add_argument("--version", action="version", version=f"confluence {confluence.__version__}")
+    parser.set_defaults(command_help=parser.print_help)
+
+    subparsers = parser.add_subparsers(dest="command_name")
+
+    confluence.attachment.subcommand.add_parser(subparsers)
+    confluence.content.subcommand.add_parser(subparsers)
+    confluence.page.subcommand.add_parser(subparsers)
+    confluence.local.subcommand.add_parser(subparsers)
+    return parser
+
+
+def main(arguments: Optional[Sequence[str]] = None):
+    parser = create_parser()
+    if arguments is None:
+        args = parser.parse_args()
+    else:
+        args = parser.parse_args(arguments)
+
+    if hasattr(args, "subcommand_func"):
+        try:
+            set_logger(args.debug)
+            args.subcommand_func(args)
+        except Exception as e:
+            logger.exception(e)
+            raise e
+
+    else:
+        # 未知のサブコマンドの場合はヘルプを表示
+        args.command_help()
+
+
+if __name__ == "__main__":
+    main()

kci_confluence_cli-0.1.0/confluence/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"  # `poetry-dynamic-versioning`を使ってGitHubのバージョンタグを取得している。変更不要

kci_confluence_cli-0.1.0/confluence/attachment/create_attachment.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+import argparse
+import logging
+from pathlib import Path
+from typing import Any
+
+import confluence
+from confluence.common.api import Api
+from confluence.common.cli import create_api_instance
+
+logger = logging.getLogger(__name__)
+
+
+def create_attachments_from_file_list(
+    api: Api, content_id: str, query_params: dict[str, Any], files: list[Path], filename_pattern: None | str, mime_type: None | str
+) -> None:
+    logger.info(f"{len(files)}件のファイルをアップロードします。")
+    success_count = 0
+    total_count = 0
+    for file in files:
+        if not file.is_file():
+            logger.warning(f"'{file}'はファイルでないので、アップロードしません。")
+            continue
+
+        if filename_pattern is not None and not file.glob(filename_pattern):
+            continue
+
+        try:
+            total_count += 1
+            api.create_attachment(content_id, file, query_params=query_params, mime_type=mime_type)
+            logger.debug(f"{total_count+1}件目: '{file}'をアップロードしました。")
+        except Exception:
+            logger.warning(f"'{file}'のアップロードに失敗しました。", exc_info=True)
+            continue
+
+        logger.debug(f"'{file}'をアップロードしました。")
+        success_count += 1
+
+    logger.info(f"{success_count}/{total_count} 件のファイルをアップロードしました。")
+
+
+def create_attachments_from_directory(
+    api: Api, content_id: str, query_params: dict[str, Any], directory: Path, filename_pattern: None | str, mime_type: None | str
+) -> None:
+    success_count = 0
+    total_count = 0
+    if not directory.is_dir():
+        logger.error(f"'{directory}'はディレクトリでないので、終了します。")
+        return
+
+    logger.info(f"ディレクトリ'{directory}'内のファイルをアップロードします。")
+
+    for file in directory.iterdir():
+        if not file.is_file():
+            continue
+        if filename_pattern is not None and not file.glob(filename_pattern):
+            continue
+        try:
+            total_count += 1
+            api.create_attachment(content_id, file, query_params=query_params, mime_type=mime_type)
+            logger.debug(f"{total_count}件目: '{file}'をアップロードしました。")
+        except Exception:
+            logger.warning(f"'{file}'のアップロードに失敗しました。", exc_info=True)
+            continue
+        success_count += 1
+
+    logger.info(f"{success_count}/{total_count}件のファイルをアップロードしました。")
+
+
+def main(args: argparse.Namespace) -> None:
+    api = create_api_instance(args)
+    content_id = args.content_id
+    query_params = {"allowDuplicated": args.allow_duplicated}
+    if args.file is not None:
+        create_attachments_from_file_list(api, content_id, query_params, args.file, filename_pattern=args.filename_pattern, mime_type=args.mime_type)
+    elif args.dir is not None:
+        create_attachments_from_directory(api, content_id, query_params, args.dir, filename_pattern=args.filename_pattern, mime_type=args.mime_type)
+
+
+def add_arguments_to_parser(parser: argparse.ArgumentParser):
+    parser.add_argument("-c", "--content_id", required=True, help="ファイルのアップロード先であるページのcontent_id")
+
+    file_group = parser.add_mutually_exclusive_group(required=True)
+    file_group.add_argument("--file", type=Path, nargs="+", help="アップロードするファイル")
+    file_group.add_argument("--dir", type=Path, help="アップロードするディレクトリ")
+
+    parser.add_argument("--mime_type", type=str, help="ファイル名からMIMEタイプが判別できないときに、この値を添付ファイルのMIMEタイプとします。")
+
+    parser.add_argument("--allow_duplicated", action="store_true", help="指定した場合は、すでに同じファイルが存在しても上書きします。")
+
+    parser.add_argument("--filename_pattern", help="glob形式のパターンに一致するファイル名だけアップロードします。(ex) '*.png'")
+    parser.set_defaults(subcommand_func=main)
+
+
+def add_parser(subparsers: argparse._SubParsersAction | None = None) -> argparse.ArgumentParser:
+    subcommand_name = "create"
+    subcommand_help = "添付ファイルを作成します。"
+
+    parser = confluence.common.cli.add_parser(subparsers, subcommand_name, subcommand_help)
+
+    add_arguments_to_parser(parser)
+    return parser

kci_confluence_cli-0.1.0/confluence/attachment/delete_attachment.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+import argparse
+import logging
+from typing import Any
+
+import confluence
+from confluence.common.api import Api
+from confluence.common.cli import create_api_instance, prompt_yesnoall
+
+logger = logging.getLogger(__name__)
+
+
+def get_attachments(api: Api, content_id: str, *, filename: None | str, media_type: None | str) -> list[dict[str, Any]]:
+    limit = 50
+    start = 0
+    results: list[dict[str, Any]] = []
+    while True:
+        result = api.get_attachments(content_id, query_params={"filename": filename, "mediaType": media_type, "start": start, "limit": limit})
+        results.extend(result["results"])
+        if result["size"] < limit:
+            break
+        start = start + limit
+    return results
+
+
+def main(args: argparse.Namespace) -> None:
+    api = create_api_instance(args)
+    content_id = args.content_id
+
+    page = api.get_content_by_id(content_id)
+    results: list[dict[str, Any]] = get_attachments(api, content_id, filename=args.filename, media_type=args.media_type)
+    if len(results) == 0:
+        logger.info(f"page title='{page['title']}'の削除対象の添付ファイルは0件なので、終了します。")
+        return
+
+    logger.info(f"page title='{page['title']}'の添付ファイル{len(results)}件を削除します。")
+
+    is_purged = args.purge
+    success_count = 0
+
+    all_yes = False
+    for index, attachment in enumerate(results):
+        attachment_id = attachment["id"]
+        attachment_title = attachment["title"]
+        try:
+            if not all_yes:
+                confirm_message = f"id='{attachment_id}', title='{attachment_title}'を削除しますか？"
+                if is_purged:
+                    confirm_message += "ゴミ箱からも完全に削除します。復元できません。"
+                else:
+                    confirm_message += "ゴミ箱に移動します。"
+
+                yes, all_yes = prompt_yesnoall(confirm_message)
+            if yes or all_yes:
+                logger.debug(f"{index+1}件目: id='{attachment_id}', title='{attachment_title}'をゴミ箱に移動します。 ")
+                api.delete_content(attachment_id, query_params={"status": "current"})
+                if is_purged:
+                    logger.debug(f"{index+1}件目: id='{attachment_id}', title='{attachment_title}'をゴミ箱から完全に削除します。 ")
+                    api.delete_content(attachment_id, query_params={"status": "trashed"})
+                success_count += 1
+
+        except Exception:
+            logger.warning(f"{index+1}件目: id='{attachment_id}', title='{attachment_title}'の削除に失敗しました。", exc_info=True)
+            continue
+
+    logger.info(f"{success_count}/{len(results)} 件の添付ファイルを削除しました。")
+
+
+def add_arguments_to_parser(parser: argparse.ArgumentParser):
+    parser.add_argument("-c", "--content_id", required=True, help="削除したい添付ファイルが存在するページのcontent_id")
+
+    parser.add_argument("--filename", help="filter parameter to return only the Attachment with the matching file name")
+    parser.add_argument("--media_type", help="filter parameter to return only Attachments with a matching Media-Type")
+    parser.add_argument("--purge", action="store_true", help="指定すると、ゴミ箱からも完全に削除します。復元できません。")
+    parser.set_defaults(subcommand_func=main)
+
+
+def add_parser(subparsers: argparse._SubParsersAction | None = None) -> argparse.ArgumentParser:
+    subcommand_name = "delete"
+    subcommand_help = "添付ファイルを削除します。"
+
+    parser = confluence.common.cli.add_parser(subparsers, subcommand_name, subcommand_help)
+
+    add_arguments_to_parser(parser)
+    return parser

kci_confluence_cli-0.1.0/confluence/attachment/get_attachment.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+import argparse
+import logging
+from pathlib import Path
+from typing import Any
+
+import confluence
+from confluence.common.cli import create_api_instance
+from confluence.common.utils import print_json
+
+logger = logging.getLogger(__name__)
+
+
+def main(args: argparse.Namespace) -> None:
+    api = create_api_instance(args)
+    content_id = args.content_id
+    expand = ",".join(args.expand) if args.expand else None
+
+    limit = 50
+    start = 0
+    results: list[dict[str, Any]] = []
+    while True:
+        result = api.get_attachments(
+            content_id, query_params={"filename": args.filename, "mediaType": args.media_type, "start": start, "limit": limit, "expand": expand}
+        )
+        results.extend(result["results"])
+        if result["size"] < limit:
+            break
+        start = start + limit
+
+    print_json(results, is_pretty=True, output=args.output)
+
+
+def add_arguments_to_parser(parser: argparse.ArgumentParser):
+    parser.add_argument("-c", "--content_id", required=True, help="取得した添付ファイルが存在するページのcontent_id")
+
+    parser.add_argument("--filename", help="filter parameter to return only the Attachment with the matching file name")
+    parser.add_argument("--media_type", help="filter parameter to return only Attachments with a matching Media-Type")
+
+    parser.add_argument("--expand", nargs="+", help="取得したい情報のプロパティ。指定できる値は出力結果の`_expandable`を参照してください。")
+
+    parser.add_argument("-o", "--output", type=Path, help="出力先")
+
+    parser.set_defaults(subcommand_func=main)
+
+
+def add_parser(subparsers: argparse._SubParsersAction | None = None) -> argparse.ArgumentParser:
+    subcommand_name = "get"
+    subcommand_help = "添付ファイルの情報を取得します。"
+
+    parser = confluence.common.cli.add_parser(subparsers, subcommand_name, subcommand_help)
+
+    add_arguments_to_parser(parser)
+    return parser

kci_confluence_cli-0.1.0/confluence/attachment/subcommand.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+import argparse
+from typing import Optional
+
+import confluence
+import confluence.attachment.create_attachment
+import confluence.attachment.delete_attachment
+import confluence.attachment.get_attachment
+
+
+def add_arguments_to_parser(parser: argparse.ArgumentParser):
+    subparsers = parser.add_subparsers(dest="subcommand_name")
+
+    # サブコマンドの定義
+    confluence.attachment.create_attachment.add_parser(subparsers)
+    confluence.attachment.delete_attachment.add_parser(subparsers)
+    confluence.attachment.get_attachment.add_parser(subparsers)
+
+
+def add_parser(subparsers: Optional[argparse._SubParsersAction] = None) -> argparse.ArgumentParser:
+    subcommand_name = "attachment"
+    subcommand_help = "添付ファイルに関するサブコマンド"
+
+    parser = confluence.common.cli.add_parser(subparsers, subcommand_name, subcommand_help, description=subcommand_help, is_subcommand=False)
+    add_arguments_to_parser(parser)
+    return parser

kci_confluence_cli-0.1.0/confluence/common/api.py

@@ -0,0 +1,164 @@
+from __future__ import annotations
+
+import logging
+import mimetypes
+import time
+from pathlib import Path
+from typing import Any, Optional
+
+from requests_toolbelt import sessions
+
+logger = logging.getLogger(__name__)
+
+QueryParams = dict[str, Any]
+RequestBody = dict[str, Any]
+
+
+class Api:
+    """
+    https://docs.atlassian.com/ConfluenceServer/rest/6.15.7/
+
+    Args:
+        base_url: example: `https://kurusugawa.jp/confluence`
+        delay_second: APIを連続で実行する際、何秒以上間隔を空けるか。Confluenceに負荷をかけすぎないようにするため、少なくとも0.3秒以上にすること。
+
+    """
+
+    def __init__(self, username: str, password: str, base_url: str, delay_second: float = 1) -> None:
+        if delay_second < 0.3:
+            raise RuntimeError(f"引数'delay_second'は0.3以上にしてください。 :: {delay_second=}")
+
+        self.base_url = base_url
+        self.session = sessions.BaseUrlSession(base_url=base_url + "/rest/api/")
+        self.session.auth = (username, password)
+
+        self.delay_second = delay_second
+        self._previous_timestamp: float = 0
+
+    def _request(
+        self,
+        http_method: str,
+        url: str,
+        *,
+        headers: Optional[dict[str, Any]] = None,
+        params: Optional[QueryParams] = None,
+        data: Any = None,  # noqa: ANN401
+        **kwargs,
+    ) -> Any:  # noqa: ANN401
+        """
+        HTTP Requestを投げて、Responseを返す。
+
+        Args:
+            http_method:
+            url_path:
+            query_params:
+            header_params:
+            body:
+            log_response_with_error: HTTP Errorが発生したときにレスポンスの中身をログに出力するか否か
+
+        Returns:
+            responseの中身。content_typeにより型が変わる。
+            application/jsonならdict型, text/*ならばstr型, それ以外ならばbite型。
+
+        """
+        now = time.time()
+        diff_time = now - self._previous_timestamp
+        if diff_time < self.delay_second:
+            time.sleep(self.delay_second - diff_time)
+
+        response = self.session.request(http_method, url, params=params, data=data, headers=headers, **kwargs)
+        self._previous_timestamp = time.time()
+
+        logger.debug(
+            "Sent a request :: %s",
+            {
+                "requests": {
+                    "http_method": http_method,
+                    "url": url,
+                    "query_params": params,
+                    "request_body_json": data,
+                    "headers": response.request.headers,
+                },
+                "response": {
+                    "status_code": response.status_code,
+                    "content_length": len(response.content),
+                },
+            },
+        )
+        response.raise_for_status()
+        return response
+
+    def get_attachments(self, content_id: str, *, query_params: Optional[QueryParams] = None) -> dict[str, Any]:
+        url = f"content/{content_id}/child/attachment"
+        return self._request("get", url, params=query_params).json()
+
+    def create_attachment(
+        self, content_id: str, file: Path, *, query_params: Optional[QueryParams] = None, mime_type: Optional[str] = None
+    ) -> dict[str, Any]:
+        """
+        Args:
+            mime_type: mimetypes.guess_type()で自動判定でMIMEタイプを取得できないときに、この値をMIMEタイプにします。
+        """
+        headers = {"X-Atlassian-Token": "nocheck"}
+        url = f"content/{content_id}/child/attachment"
+        new_mime_type, _ = mimetypes.guess_type(file)
+        if new_mime_type is None:
+            new_mime_type = mime_type
+
+        with file.open("rb") as f:
+            files = {"file": (file.name, f, new_mime_type)}
+            return self._request("post", url, params=query_params, files=files, headers=headers).json()
+
+    def get_content(self, *, query_params: Optional[QueryParams] = None) -> list[dict[str, Any]]:
+        """
+        Returns a paginated list of Content.
+
+        https://docs.atlassian.com/ConfluenceServer/rest/6.15.7/#api/content-getContent
+        """
+        return self._request("get", "content", params=query_params).json()
+
+    def get_content_by_id(self, content_id: str, *, query_params: Optional[QueryParams] = None) -> dict[str, Any]:
+        """
+        Returns a piece of Content.
+
+        https://docs.atlassian.com/ConfluenceServer/rest/6.15.7/#api/content-getContentById
+        """
+        return self._request("get", f"content/{content_id}", params=query_params).json()
+
+    def update_content(
+        self, content_id: str, *, query_params: Optional[QueryParams] = None, request_body: Optional[RequestBody] = None
+    ) -> dict[str, Any]:
+        """
+        Updates a piece of Content, including changes to content status
+
+        https://docs.atlassian.com/ConfluenceServer/rest/6.15.7/#api/content-update
+        """
+        headers = {"Content-Type": "application/json", "X-Atlassian-Token": "nocheck"}
+        return self._request("put", f"content/{content_id}", headers=headers, params=query_params, data=request_body).json()
+
+    def delete_content(self, content_id: str, *, query_params: Optional[QueryParams] = None) -> None:
+        """
+        Trashes or purges a piece of Content, based on its {@link ContentType} and {@link ContentStatus}.
+
+        https://docs.atlassian.com/ConfluenceServer/rest/6.15.7/#api/content-delete
+
+        Notes:
+            クエリパラーメタ`status`に`trashed`を指定すると400エラーが発生した。
+        """
+        self._request("delete", f"content/{content_id}", params=query_params)
+
+    def get_content_history(self, content_id: str, *, query_params: Optional[QueryParams] = None):
+        """Returns the history of a particular piece of content
+
+        https://docs.atlassian.com/ConfluenceServer/rest/6.15.7/#api/content-getHistory
+        """
+        return self._request("get", f"content/{content_id}/history", params=query_params).json()
+
+    def search_content(self, *, query_params: Optional[QueryParams] = None) -> dict[str, Any]:
+        """
+        Fetch a list of content using the Confluence Query Language (CQL)
+
+        https://docs.atlassian.com/ConfluenceServer/rest/6.15.7/#api/content-search
+        """
+        response = self.session.get("content/search", params=query_params)
+        return response.json()