wpctl 1.0.0__tar.gz

wpctl-1.0.0/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 templates
+
+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.

wpctl-1.0.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: wpctl
+Version: 1.0.0
+Summary: WordPress APIを活用して記事を投稿・管理するCLIツール
+Author-email: "Ryoh.Ya" <dev.p.ry.yamafuji@gmail.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: markdown>=3.7
+Requires-Dist: nh3>=0.2.18
+Requires-Dist: requests>=2.32
+Dynamic: license-file
+
+# wpctl
+
+WordPress APIを活用して、記事を投稿・管理するCLIツール。
+
+## 概要
+
+MarkDown / テキスト / HTMLファイルを読み込み、WordPress REST APIを通じて記事の投稿・更新を行います。
+
+## 機能
+
+| 機能     | コマンド            | 説明                                       |
+| -------- | ------------------- | ------------------------------------------ |
+| 記事投稿 | `wpctl post create` | Markdownなどのファイルを記事として投稿する |
+| 記事更新 | `wpctl post update` | 既存の記事をファイルの内容で更新する       |
+
+## インストール
+
+```sh
+pip install .
+```
+
+## 使い方
+
+### 記事を投稿する
+
+```sh
+wpctl post create [-t "記事のタイトル"] <FilePath>
+```
+
+| 引数 | オプション | 必須 | 説明 |
+| ---- | ---------- | ---- | ---- |
+| `FilePath` | | true | 投稿するファイルのパス |
+| `title` | `--title`, `-t` | | 記事タイトル（デフォルト: `タイトル未設定`）|
+
+### 記事を更新する
+
+```sh
+wpctl post update --id <ID> [-t "記事のタイトル"] <FilePath>
+```
+
+| 引数 | オプション | 必須 | 説明 |
+| ---- | ---------- | ---- | ---- |
+| `FilePath` | | true | 投稿するファイルのパス |
+| `id` | `--id` | true | 更新対象の記事ID |
+| `title` | `--title`, `-t` | | 記事タイトル（デフォルト: `タイトル未設定`）|
+
+## 環境変数
+
+| 環境変数          | 必須 | 説明                        |
+| ----------------- | ---- | --------------------------- |
+| `WP_USER`         | true | WordPressのユーザー名       |
+| `WP_APP_PASSWORD` | true | WordPressのアプリパスワード |
+
+> `.env` ファイルは非対応です。あらかじめシェルの環境変数に設定してください。
+
+## 対応ファイル形式
+
+- `.txt`
+- `.md`
+- `.html`
+
+## Tool
+
+### Test
+
+```sh
+pip install -r requirements-dev.txt
+pytest tests/
+# ログを出力する場合
+# pytest -s tests/
+```
+
+### Lint
+
+```sh
+pip install -r requirements-dev.txt
+ruff check .
+# 自動修正する場合
+ruff check . --fix
+```

wpctl-1.0.0/README.md

@@ -0,0 +1,80 @@
+# wpctl
+
+WordPress APIを活用して、記事を投稿・管理するCLIツール。
+
+## 概要
+
+MarkDown / テキスト / HTMLファイルを読み込み、WordPress REST APIを通じて記事の投稿・更新を行います。
+
+## 機能
+
+| 機能     | コマンド            | 説明                                       |
+| -------- | ------------------- | ------------------------------------------ |
+| 記事投稿 | `wpctl post create` | Markdownなどのファイルを記事として投稿する |
+| 記事更新 | `wpctl post update` | 既存の記事をファイルの内容で更新する       |
+
+## インストール
+
+```sh
+pip install .
+```
+
+## 使い方
+
+### 記事を投稿する
+
+```sh
+wpctl post create [-t "記事のタイトル"] <FilePath>
+```
+
+| 引数 | オプション | 必須 | 説明 |
+| ---- | ---------- | ---- | ---- |
+| `FilePath` | | true | 投稿するファイルのパス |
+| `title` | `--title`, `-t` | | 記事タイトル（デフォルト: `タイトル未設定`）|
+
+### 記事を更新する
+
+```sh
+wpctl post update --id <ID> [-t "記事のタイトル"] <FilePath>
+```
+
+| 引数 | オプション | 必須 | 説明 |
+| ---- | ---------- | ---- | ---- |
+| `FilePath` | | true | 投稿するファイルのパス |
+| `id` | `--id` | true | 更新対象の記事ID |
+| `title` | `--title`, `-t` | | 記事タイトル（デフォルト: `タイトル未設定`）|
+
+## 環境変数
+
+| 環境変数          | 必須 | 説明                        |
+| ----------------- | ---- | --------------------------- |
+| `WP_USER`         | true | WordPressのユーザー名       |
+| `WP_APP_PASSWORD` | true | WordPressのアプリパスワード |
+
+> `.env` ファイルは非対応です。あらかじめシェルの環境変数に設定してください。
+
+## 対応ファイル形式
+
+- `.txt`
+- `.md`
+- `.html`
+
+## Tool
+
+### Test
+
+```sh
+pip install -r requirements-dev.txt
+pytest tests/
+# ログを出力する場合
+# pytest -s tests/
+```
+
+### Lint
+
+```sh
+pip install -r requirements-dev.txt
+ruff check .
+# 自動修正する場合
+ruff check . --fix
+```

wpctl-1.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+[project]
+name = "wpctl"
+version = "1.0.0"
+description = "WordPress APIを活用して記事を投稿・管理するCLIツール"
+authors = [
+    { name = "Ryoh.Ya", email = "dev.p.ry.yamafuji@gmail.com" }
+]
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "markdown>=3.7",
+    "nh3>=0.2.18",
+    "requests>=2.32",
+]
+[project.scripts]
+wpctl = "wpctl.main:main"
+[tool.setuptools.packages.find]
+where = ["src"]

wpctl-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wpctl-1.0.0/src/wpctl/api/api_wordpress.py

@@ -0,0 +1,104 @@
+import os
+
+import requests
+
+from wpctl.utils.custom_logger import get_logger
+
+logger = get_logger(__name__)
+
+
+class WordPressAPIError(Exception):
+    """WordPress API 呼び出しエラー。"""
+
+
+class ApiWordpress:
+    """WordPress REST API クライアント。
+
+    Notes:
+        WordPress REST API のエンドポイントは通常 /wp-json/wp/v2/
+    """
+
+    def __init__(self) -> None:
+        self._site_url = os.environ["WP_SITE_URL"].rstrip("/")
+        self._auth = (os.environ["WP_USER"], os.environ["WP_APP_PASSWORD"])
+
+    def get_me(self) -> dict:
+        """認証情報の疎通確認。
+
+        Returns:
+            認証ユーザーの情報
+
+        Raises:
+            WordPressAPIError: API呼び出しに失敗した場合
+        """
+        url = f"{self._site_url}/wp-json/wp/v2/users/me"
+        try:
+            response = requests.get(url, auth=self._auth)
+            response.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            logger.error(f"認証に失敗しました: {e}")
+            raise WordPressAPIError(f"認証に失敗しました: {e}") from e
+        logger.info(
+            f"Authentication successful for user: {response.json().get('name')}"
+        )
+        return response.json()
+
+    def create_post(
+        self,
+        title: str,
+        content: str,
+        status: str = "publish",
+    ) -> dict:
+        """新しい記事を投稿する。
+
+        Args:
+            title: 記事のタイトル
+            content: 記事の内容（HTML）
+            status: 記事のステータス（'publish' または 'draft'）
+
+        Returns:
+            作成された記事の情報
+
+        Raises:
+            WordPressAPIError: API呼び出しに失敗した場合
+        """
+        url = f"{self._site_url}/wp-json/wp/v2/posts"
+        payload = {"title": title, "content": content, "status": status}
+        try:
+            response = requests.post(url, json=payload, auth=self._auth)
+            response.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            logger.error(f"記事の投稿に失敗しました: {e}")
+            raise WordPressAPIError(f"記事の投稿に失敗しました: {e}") from e
+        logger.info(f"Post created successfully: {response.json().get('link')}")
+        return response.json()
+
+    def update_post(
+        self,
+        post_id: int,
+        title: str,
+        content: str,
+    ) -> dict:
+        """既存の記事を更新する。
+
+        Args:
+            post_id: 更新する記事のID
+            title: 更新後のタイトル
+            content: 更新後の内容（HTML）
+
+        Returns:
+            更新された記事の情報
+
+        Raises:
+            WordPressAPIError: API呼び出しに失敗した場合
+        """
+        url = f"{self._site_url}/wp-json/wp/v2/posts/{post_id}"
+        payload = {"title": title, "content": content}
+        try:
+            response = requests.post(url, json=payload, auth=self._auth)
+            response.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            logger.error(f"記事の更新に失敗しました: id={post_id}, {e}")
+            raise WordPressAPIError(f"記事の更新に失敗しました: {e}") from e
+        logger.info(f"Post updated successfully: {response.json().get('link')}")
+        return response.json()

wpctl-1.0.0/src/wpctl/commands/create.py

@@ -0,0 +1,22 @@
+from wpctl.api.api_wordpress import ApiWordpress
+from wpctl.libs.file_reader import read_file
+from wpctl.utils.custom_logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def run(file_path: str, title: str) -> dict:
+    """記事を投稿する。
+
+    Args:
+        file_path: 投稿するファイルのパス（.txt / .html / .md）
+        title: 記事のタイトル
+
+    Returns:
+        WordPress API のレスポンスデータ
+    """
+    content = read_file(file_path)
+    api = ApiWordpress()
+    result = api.create_post(title=title, content=content)
+    logger.info(f"記事を投稿しました: id={result.get('id')}, link={result.get('link')}")
+    return result

wpctl-1.0.0/src/wpctl/commands/update.py

@@ -0,0 +1,25 @@
+from wpctl.api.api_wordpress import ApiWordpress
+from wpctl.libs.file_reader import read_file
+from wpctl.utils.custom_logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def run(file_path: str, post_id: int, title: str) -> dict:
+    """記事を更新する。
+
+    Args:
+        file_path: 投稿するファイルのパス（.txt / .html / .md）
+        post_id: 更新する記事のID
+        title: 記事のタイトル
+
+    Returns:
+        WordPress API のレスポンスデータ
+    """
+    content = read_file(file_path)
+    api = ApiWordpress()
+    result = api.update_post(post_id=post_id, title=title, content=content)
+    logger.info(
+        f"記事を更新しました: id={result.get('id')}, link={result.get('link')}"
+    )
+    return result

wpctl-1.0.0/src/wpctl/libs/file_reader.py

@@ -0,0 +1,48 @@
+from pathlib import Path
+
+from wpctl.libs.md_to_html import convert
+from wpctl.utils.custom_logger import get_logger
+
+logger = get_logger(__name__)
+
+SUPPORTED_EXTENSIONS = {".txt", ".html", ".md"}
+
+
+class FileReadError(Exception):
+    """ファイル読み込みエラー。"""
+
+
+def read_file(file_path: str) -> str:
+    """ファイルを読み込んで文字列として返す。
+
+    Markdownファイルはサニタイズ済みHTMLに変換して返す。
+    .txt / .html はそのまま返す。
+
+    Args:
+        file_path: 読み込むファイルのパス
+
+    Returns:
+        ファイルの内容（Markdownの場合はHTML変換済み）
+
+    Raises:
+        FileReadError: ファイルが存在しない、または未対応の拡張子の場合
+    """
+    path = Path(file_path)
+
+    if not path.exists():
+        raise FileReadError(f"ファイルが見つかりません: {file_path}")
+
+    ext = path.suffix.lower()
+    if ext not in SUPPORTED_EXTENSIONS:
+        supported = ", ".join(sorted(SUPPORTED_EXTENSIONS))
+        raise FileReadError(
+            f"未対応のファイル形式です: {ext}（対応形式: {supported}）"
+        )
+
+    text = path.read_text(encoding="utf-8")
+    logger.info(f"ファイルを読み込みました: {file_path}")
+
+    if ext == ".md":
+        return convert(text)
+
+    return text

wpctl-1.0.0/src/wpctl/libs/md_to_html.py

@@ -0,0 +1,35 @@
+import markdown
+import nh3
+
+_ALLOWED_TAGS = {
+    "p", "br", "strong", "b", "em", "i", "u", "s",
+    "h1", "h2", "h3", "h4", "h5", "h6",
+    "ul", "ol", "li", "dl", "dt", "dd",
+    "blockquote", "pre", "code",
+    "table", "thead", "tbody", "tr", "th", "td",
+    "a", "img", "hr",
+}
+
+_ALLOWED_ATTRIBUTES: dict[str, set[str]] = {
+    "a": {"href", "title", "target"},
+    "img": {"src", "alt", "width", "height"},
+    "td": {"colspan", "rowspan"},
+    "th": {"colspan", "rowspan"},
+    "code": {"class"},
+    "pre": {"class"},
+}
+
+
+def convert(text: str) -> str:
+    """MarkdownをサニタイズされたHTMLに変換する。
+
+    script タグ・イベント属性・外部JavaScript埋め込みを除去する。
+
+    Args:
+        text: Markdown形式のテキスト
+
+    Returns:
+        サニタイズ済みのHTML文字列
+    """
+    html = markdown.markdown(text, extensions=["tables", "fenced_code"])
+    return nh3.clean(html, tags=_ALLOWED_TAGS, attributes=_ALLOWED_ATTRIBUTES)

wpctl-1.0.0/src/wpctl/main.py

@@ -0,0 +1,82 @@
+import argparse
+import os
+import sys
+
+from wpctl.run import run
+from wpctl.utils.custom_logger import get_logger
+
+logger = get_logger(__name__)
+
+_REQUIRED_ENV_VARS = ["WP_SITE_URL", "WP_USER", "WP_APP_PASSWORD"]
+
+
+def _validate_env() -> None:
+    """必須環境変数が設定されているか検証する。
+
+    Raises:
+        SystemExit: 未設定の環境変数が存在する場合
+    """
+    missing = [var for var in _REQUIRED_ENV_VARS if not os.environ.get(var)]
+    if missing:
+        for var in missing:
+            print(f"Error: 環境変数 {var} が設定されていません。", file=sys.stderr)
+        sys.exit(1)
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    """CLIパーサーを構築する。
+
+    Returns:
+        ArgumentParser: 構築済みのパーサー
+    """
+    parser = argparse.ArgumentParser(
+        prog="wpctl",
+        description="WordPress APIを活用して記事を投稿・管理するCLIツール",
+    )
+    subparsers = parser.add_subparsers(dest="command")
+
+    post_parser = subparsers.add_parser("post", help="記事を管理する")
+    post_subparsers = post_parser.add_subparsers(dest="subcommand")
+
+    create_parser = post_subparsers.add_parser("create", help="記事を投稿する")
+    create_parser.add_argument(
+        "file_path", metavar="FilePath", help="投稿するファイルのパス"
+    )
+    create_parser.add_argument(
+        "--title", "-t",
+        default="タイトル未設定",
+        help="記事のタイトル（デフォルト: タイトル未設定）",
+    )
+
+    update_parser = post_subparsers.add_parser("update", help="記事を更新する")
+    update_parser.add_argument(
+        "file_path", metavar="FilePath", help="投稿するファイルのパス"
+    )
+    update_parser.add_argument(
+        "--id", dest="post_id", type=int, required=True, help="更新する記事のID"
+    )
+    update_parser.add_argument(
+        "--title", "-t",
+        default="タイトル未設定",
+        help="記事のタイトル（デフォルト: タイトル未設定）",
+    )
+
+    return parser
+
+
+def main():
+    """エントリーポイント。CLI引数を解析してrunに渡す。"""
+    parser = _build_parser()
+    args = parser.parse_args()
+
+    if args.command is None:
+        parser.print_help()
+        return
+
+    _validate_env()
+    logger.info(f"wpctl {args.command} {args.subcommand}")
+    run(args)
+
+
+if __name__ == "__main__":
+    main()

wpctl-1.0.0/src/wpctl/run.py

@@ -0,0 +1,67 @@
+import argparse
+import sys
+
+from wpctl.api.api_wordpress import WordPressAPIError
+from wpctl.libs.file_reader import FileReadError
+from wpctl.utils.custom_logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def run(args: argparse.Namespace) -> None:
+    """ツールのロジック開始点。コマンドに応じた処理を呼び出す。
+
+    Args:
+        args: argparseで解析された引数
+    """
+    if args.command == "post":
+        _run_post(args)
+    else:
+        raise ValueError(f"Unknown command: {args.command}")
+
+
+def _run_post(args: argparse.Namespace) -> None:
+    """post コマンドのサブコマンドを振り分ける。
+
+    Args:
+        args: argparseで解析された引数
+    """
+    if args.subcommand == "create":
+        _run_post_create(args)
+    elif args.subcommand == "update":
+        _run_post_update(args)
+    else:
+        raise ValueError(f"Unknown subcommand: {args.subcommand}")
+
+
+def _run_post_create(args: argparse.Namespace) -> None:
+    """記事を投稿する。
+
+    Args:
+        args: argparseで解析された引数
+            file_path: 投稿するファイルのパス
+            title: 記事のタイトル
+    """
+    from wpctl.commands.create import run as create_run
+    try:
+        create_run(file_path=args.file_path, title=args.title)
+    except (FileReadError, WordPressAPIError) as e:
+        logger.error(str(e))
+        sys.exit(1)
+
+
+def _run_post_update(args: argparse.Namespace) -> None:
+    """記事を更新する。
+
+    Args:
+        args: argparseで解析された引数
+            file_path: 投稿するファイルのパス
+            post_id: 更新する記事のID
+            title: 記事のタイトル
+    """
+    from wpctl.commands.update import run as update_run
+    try:
+        update_run(file_path=args.file_path, post_id=args.post_id, title=args.title)
+    except (FileReadError, WordPressAPIError) as e:
+        logger.error(str(e))
+        sys.exit(1)