redtile 0.0.17__tar.gz

redtile-0.0.17/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.3
+Name: redtile
+Version: 0.0.17
+Summary: Redmine CLI tool
+Author: kawagh
+Author-email: kawagh <kawagh.dev@gmail.com>
+Requires-Dist: argcomplete>=3.6.3
+Requires-Dist: prompt-toolkit>=3.0.52
+Requires-Dist: requests>=2.33.1
+Requires-Dist: tomlkit>=0.14.0
+Requires-Dist: wcwidth>=0.2.13
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# redi
+
+redmine CLI tool
+
+## install
+
+Install via [uv](https://github.com/astral-sh/uv)
+
+```shell
+uv tool install https://github.com/kawagh/redi.git
+```
+
+## install(for development)
+
+In repository root
+
+```sh
+uv tool install -e .
+```
+
+## setup
+
+### config
+
+To use redi, you need to set remdine url and redmine_api_key in one of below ways.
+
+#### environment variable
+
+```sh
+export REDMINE_URL=xxx
+export REDMINE_API_KEY=yyy
+```
+
+#### ~/.config/redi/config.toml
+
+```toml
+default_profile = "main"
+
+["main"]
+redmine_url = "xxx"
+redmine_api_key = "yyy"
+default_project_id = "1"
+wiki_project_id = "2"
+editor = "nvim"
+
+["sub"]
+redmine_url = "vvv"
+redmine_api_key = "www"
+default_project_id = "2"
+wiki_project_id = "3"
+editor = "code"
+```
+
+### setup completion
+
+```sh
+uv tool install argcomplete
+echo 'eval "$(register-python-argcomplete redi)"' >> ~/.zshrc
+```
+
+## usage(example)
+
+```sh
+# config (alias: c)
+redi config
+redi config create <profile_name> --url <url> --api_key <key> # create new profile
+redi config create <profile_name> --url <url> --api_key <key> --set_default
+redi config update --default_profile <profile_name> # switch profile
+redi config update <profile_name> --editor nvim # update profile
+redi --profile <profile_name> issue # 一時的にプロファイルを切り替えて実行
+
+# project (alias: p)
+redi project # list projects
+redi project list # 同上 (`redi project l` / `redi p list` / `redi p l` / `redi p` も同じ)
+redi project view <project_id> # view project
+redi project view <project_id> --include trackers,issue_categories
+redi project create <name> <identifier>
+redi project create <name> <identifier> -d "description" --is_public true
+redi project update <project_id> --name renamed_project
+
+# issue (alias: i)
+redi issue # list issues
+redi issue -p <project_id> -a me -s open
+redi issue -q <query_id>
+redi issue view <issue_id>
+redi issue view <issue_id> --web # view issue with web browser
+redi issue view <issue_id> --include journals,attachments,relations
+redi issue create # (interactive)
+redi issue create "subject" -p <project_id> -t <tracker_id> -a <user_id> -d "description"
+redi issue update <issue_id> # (interactive)
+redi issue update <issue_id> --status_id <status_id> -n "notes"
+redi issue update <issue_id> --relate relates --to <other_issue_id>
+redi issue update <issue_id> --attach ./foo.png --attach ./bar.log
+redi issue comment <issue_id> "hello~"
+redi issue delete <issue_id> # (confirm before delete)
+redi issue delete <issue_id> -y # skip confirmation
+
+# version (alias: v)
+redi version # list versions(fixed_versions)
+redi version -p <project_id>
+redi version view <version_id>
+redi version create <name> -p <project_id> --due_date 2026-12-31 --status open
+redi version update <version_id> --status closed
+
+# wiki (alias: w)
+redi wiki
+redi wiki -p <project_id>
+redi wiki view <page_title>
+redi wiki create # (interactive)
+redi wiki update # (interactive)
+
+# file (プロジェクトファイル)
+redi file -p <project_id> # list
+redi file create ./foo.zip -p <project_id> -d "description"
+
+# attachment
+redi attachment view <attachment_id>
+redi attachment update <attachment_id> -f new_name.png -d "desc"
+redi attachment delete <attachment_id> # confirm before delete (-y to skip)
+
+# relation (イシュー関係性詳細)
+redi relation view <relation_id>
+
+# time_entry (作業時間)
+redi time_entry -p <project_id> -u me
+redi time_entry create 1.5 -i <issue_id> -a <activity_id> -c "comment"
+redi time_entry update <time_entry_id> --hours 2.0
+redi time_entry delete <time_entry_id> # confirm before delete (-y to skip)
+
+# me (自分のアカウント)
+redi me
+redi me update -f <firstname> -l <lastname> -m <mail>
+
+# membership (alias: m)
+redi membership -p <project_id>
+redi membership view <membership_id>
+
+# news
+redi news -p <project_id>
+
+# issue_category
+redi issue_category -p <project_id>
+redi issue_category create "category" -p <project_id>
+
+# others
+redi user # list users (alias: u)
+redi tracker # list trackers
+redi issue_status # list issue statuses
+redi issue_priority # list priorities
+redi time_entry_activity # list activities
+redi document_category # list document categories
+redi role # list roles
+redi group # list groups
+redi custom_field # list custom fields
+redi query # list custom queries
+redi search "keyword"
+redi --version
+redi --tui
+```

redtile-0.0.17/README.md

@@ -0,0 +1,159 @@
+# redi
+
+redmine CLI tool
+
+## install
+
+Install via [uv](https://github.com/astral-sh/uv)
+
+```shell
+uv tool install https://github.com/kawagh/redi.git
+```
+
+## install(for development)
+
+In repository root
+
+```sh
+uv tool install -e .
+```
+
+## setup
+
+### config
+
+To use redi, you need to set remdine url and redmine_api_key in one of below ways.
+
+#### environment variable
+
+```sh
+export REDMINE_URL=xxx
+export REDMINE_API_KEY=yyy
+```
+
+#### ~/.config/redi/config.toml
+
+```toml
+default_profile = "main"
+
+["main"]
+redmine_url = "xxx"
+redmine_api_key = "yyy"
+default_project_id = "1"
+wiki_project_id = "2"
+editor = "nvim"
+
+["sub"]
+redmine_url = "vvv"
+redmine_api_key = "www"
+default_project_id = "2"
+wiki_project_id = "3"
+editor = "code"
+```
+
+### setup completion
+
+```sh
+uv tool install argcomplete
+echo 'eval "$(register-python-argcomplete redi)"' >> ~/.zshrc
+```
+
+## usage(example)
+
+```sh
+# config (alias: c)
+redi config
+redi config create <profile_name> --url <url> --api_key <key> # create new profile
+redi config create <profile_name> --url <url> --api_key <key> --set_default
+redi config update --default_profile <profile_name> # switch profile
+redi config update <profile_name> --editor nvim # update profile
+redi --profile <profile_name> issue # 一時的にプロファイルを切り替えて実行
+
+# project (alias: p)
+redi project # list projects
+redi project list # 同上 (`redi project l` / `redi p list` / `redi p l` / `redi p` も同じ)
+redi project view <project_id> # view project
+redi project view <project_id> --include trackers,issue_categories
+redi project create <name> <identifier>
+redi project create <name> <identifier> -d "description" --is_public true
+redi project update <project_id> --name renamed_project
+
+# issue (alias: i)
+redi issue # list issues
+redi issue -p <project_id> -a me -s open
+redi issue -q <query_id>
+redi issue view <issue_id>
+redi issue view <issue_id> --web # view issue with web browser
+redi issue view <issue_id> --include journals,attachments,relations
+redi issue create # (interactive)
+redi issue create "subject" -p <project_id> -t <tracker_id> -a <user_id> -d "description"
+redi issue update <issue_id> # (interactive)
+redi issue update <issue_id> --status_id <status_id> -n "notes"
+redi issue update <issue_id> --relate relates --to <other_issue_id>
+redi issue update <issue_id> --attach ./foo.png --attach ./bar.log
+redi issue comment <issue_id> "hello~"
+redi issue delete <issue_id> # (confirm before delete)
+redi issue delete <issue_id> -y # skip confirmation
+
+# version (alias: v)
+redi version # list versions(fixed_versions)
+redi version -p <project_id>
+redi version view <version_id>
+redi version create <name> -p <project_id> --due_date 2026-12-31 --status open
+redi version update <version_id> --status closed
+
+# wiki (alias: w)
+redi wiki
+redi wiki -p <project_id>
+redi wiki view <page_title>
+redi wiki create # (interactive)
+redi wiki update # (interactive)
+
+# file (プロジェクトファイル)
+redi file -p <project_id> # list
+redi file create ./foo.zip -p <project_id> -d "description"
+
+# attachment
+redi attachment view <attachment_id>
+redi attachment update <attachment_id> -f new_name.png -d "desc"
+redi attachment delete <attachment_id> # confirm before delete (-y to skip)
+
+# relation (イシュー関係性詳細)
+redi relation view <relation_id>
+
+# time_entry (作業時間)
+redi time_entry -p <project_id> -u me
+redi time_entry create 1.5 -i <issue_id> -a <activity_id> -c "comment"
+redi time_entry update <time_entry_id> --hours 2.0
+redi time_entry delete <time_entry_id> # confirm before delete (-y to skip)
+
+# me (自分のアカウント)
+redi me
+redi me update -f <firstname> -l <lastname> -m <mail>
+
+# membership (alias: m)
+redi membership -p <project_id>
+redi membership view <membership_id>
+
+# news
+redi news -p <project_id>
+
+# issue_category
+redi issue_category -p <project_id>
+redi issue_category create "category" -p <project_id>
+
+# others
+redi user # list users (alias: u)
+redi tracker # list trackers
+redi issue_status # list issue statuses
+redi issue_priority # list priorities
+redi time_entry_activity # list activities
+redi document_category # list document categories
+redi role # list roles
+redi group # list groups
+redi custom_field # list custom fields
+redi query # list custom queries
+redi search "keyword"
+redi --version
+redi --tui
+```

redtile-0.0.17/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "redtile"
+version = "0.0.17"
+description = "Redmine CLI tool"
+readme = "README.md"
+authors = [
+    { name = "kawagh", email = "kawagh.dev@gmail.com" }
+]
+requires-python = ">=3.13"
+dependencies = [
+    "argcomplete>=3.6.3",
+    "prompt-toolkit>=3.0.52",
+    "requests>=2.33.1",
+    "tomlkit>=0.14.0",
+    "wcwidth>=0.2.13",
+]
+
+[project.scripts]
+redi = "redi.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.9.2,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+    "ruff>=0.15.9",
+    "ty>=0.0.31",
+]
+
+[tool.uv.build-backend]
+module-name = "redi"

redtile-0.0.17/src/redi/api/attachment.py

@@ -0,0 +1,110 @@
+import json
+import mimetypes
+import os
+
+import requests
+
+from redi.client import client
+from redi.config import redmine_url
+
+
+def upload_file(file_path: str) -> dict:
+    if not os.path.isfile(file_path):
+        print(f"ファイルが見つかりません: {file_path}")
+        exit(1)
+    filename = os.path.basename(file_path)
+    content_type = mimetypes.guess_type(filename)[0] or "application/octet-stream"
+    with open(file_path, "rb") as f:
+        response = client.post(
+            "/uploads.json",
+            headers={"Content-Type": "application/octet-stream"},
+            data=f,
+        )
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        print(e)
+        print(e.response.text)
+        print(f"ファイルのアップロードに失敗しました: {file_path}")
+        exit(1)
+    token = response.json()["upload"]["token"]
+    return {
+        "token": token,
+        "filename": filename,
+        "content_type": content_type,
+    }
+
+
+def fetch_attachment(attachment_id: str) -> dict:
+    response = client.get(f"/attachments/{attachment_id}.json")
+    if response.status_code == 404:
+        print(f"添付ファイルが見つかりません: #{attachment_id}")
+        exit(1)
+    response.raise_for_status()
+    return response.json()["attachment"]
+
+
+def read_attachment(attachment_id: str, full: bool = False) -> None:
+    attachment = fetch_attachment(attachment_id)
+    if full:
+        print(json.dumps(attachment, ensure_ascii=False))
+        return
+    lines = [
+        f"{attachment['id']} {attachment['filename']}",
+        f"サイズ: {attachment.get('filesize', '')}",
+        f"種別: {attachment.get('content_type', '')}",
+    ]
+    author = attachment.get("author") or {}
+    if author:
+        lines.append(f"作成者: {author.get('name', '')}")
+    if attachment.get("created_on"):
+        lines.append(f"作成日時: {attachment['created_on']}")
+    if attachment.get("description"):
+        lines.append(f"説明: {attachment['description']}")
+    if attachment.get("content_url"):
+        lines.append(f"URL: {attachment['content_url']}")
+    print("\n".join(lines))
+
+
+def delete_attachment(attachment_id: str) -> None:
+    response = client.delete(f"/attachments/{attachment_id}.json")
+    if response.status_code == 404:
+        print(f"添付ファイルが見つかりません: #{attachment_id}")
+        exit(1)
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        print(e)
+        print(e.response.text)
+        print("添付ファイルの削除に失敗しました")
+        exit(1)
+    print(f"添付ファイルを削除しました: #{attachment_id}")
+
+
+def update_attachment(
+    attachment_id: str,
+    filename: str | None = None,
+    description: str | None = None,
+) -> None:
+    data: dict = {}
+    if filename is not None:
+        data["filename"] = filename
+    if description is not None:
+        data["description"] = description
+    if not data:
+        print("更新をキャンセルしました")
+        exit()
+    response = client.patch(
+        f"/attachments/{attachment_id}.json", json={"attachment": data}
+    )
+    if response.status_code == 404:
+        print(f"添付ファイルが見つかりません: #{attachment_id}")
+        exit(1)
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        print(e)
+        print(e.response.text)
+        print("添付ファイルの更新に失敗しました")
+        exit(1)
+    print(f"添付ファイルを更新しました: {redmine_url}/attachments/{attachment_id}")

redtile-0.0.17/src/redi/api/custom_field.py

@@ -0,0 +1,72 @@
+import json
+
+from redi import cache
+from redi.client import client
+
+CACHE_KEY = "custom_fields"
+
+
+def fetch_custom_fields() -> list[dict] | None:
+    cached = cache.load(CACHE_KEY)
+    if cached is not None:
+        return cached
+    response = client.get("/custom_fields.json")
+    if response.status_code == 403:
+        # https://www.redmine.org/projects/redmine/wiki/Rest_CustomFields
+        # https://www.redmine.org/issues/18875
+        return
+    response.raise_for_status()
+    data = response.json()["custom_fields"]
+    cache.save(CACHE_KEY, data)
+    return data
+
+
+def list_custom_fields(full: bool = False) -> None:
+    custom_fields = fetch_custom_fields()
+    if custom_fields is None:
+        print("カスタムフィールドの取得には管理者権限が必要です")
+        exit(1)
+    if full:
+        print(json.dumps(custom_fields, ensure_ascii=False))
+    else:
+        for cf in custom_fields:
+            print(f"{cf['id']} {cf['name']}")
+
+
+def fetch_project_issue_custom_field_ids(project_id: str) -> set[int]:
+    """プロジェクトで有効なイシュー用カスタムフィールドのIDを取得する。"""
+    response = client.get(
+        f"/projects/{project_id}.json", params={"include": "issue_custom_fields"}
+    )
+    response.raise_for_status()
+    project = response.json()["project"]
+
+    return {cf["id"] for cf in project.get("issue_custom_fields") or []}
+
+
+def filter_required_issue_custom_fields(
+    custom_fields: list[dict],
+    project_cf_ids: set[int],
+    tracker_id: str | None,
+) -> list[dict]:
+    """
+    入力必須・初期値なし・プロジェクト/トラッカーに該当する
+    イシュー用カスタムフィールドを抽出する。
+    """
+    result = []
+    for cf in custom_fields:
+        if cf.get("customized_type") != "issue":
+            continue
+        if not cf.get("is_required"):
+            continue
+        if cf.get("default_value"):
+            continue
+        if cf["id"] not in project_cf_ids:
+            continue
+        trackers = cf.get("trackers") or []
+        if trackers and tracker_id is not None:
+            tracker_ids = {str(t["id"]) for t in trackers}
+            if str(tracker_id) not in tracker_ids:
+                continue
+        result.append(cf)
+    return result

redtile-0.0.17/src/redi/api/enumeration.py

@@ -0,0 +1,44 @@
+import json
+
+from redi import cache
+from redi.client import client
+
+
+def _fetch_enumeration(resource: str) -> list[dict]:
+    cached = cache.load(resource)
+    if cached is not None:
+        return cached
+    response = client.get(f"/enumerations/{resource}.json")
+    response.raise_for_status()
+    data = response.json()[resource]
+    cache.save(resource, data)
+    return data
+
+
+def _list_enumeration(resource: str, full: bool = False) -> None:
+    items = _fetch_enumeration(resource)
+    if full:
+        print(json.dumps(items, ensure_ascii=False))
+    else:
+        for item in items:
+            print(f"{item['id']} {item['name']}")
+
+
+def fetch_issue_priorities() -> list[dict]:
+    return _fetch_enumeration("issue_priorities")
+
+
+def list_issue_priorities(full: bool = False) -> None:
+    _list_enumeration("issue_priorities", full)
+
+
+def fetch_time_entry_activities() -> list[dict]:
+    return _fetch_enumeration("time_entry_activities")
+
+
+def list_time_entry_activities(full: bool = False) -> None:
+    _list_enumeration("time_entry_activities", full)
+
+
+def list_document_categories(full: bool = False) -> None:
+    _list_enumeration("document_categories", full)

redtile-0.0.17/src/redi/api/file.py

@@ -0,0 +1,55 @@
+import json
+
+import requests
+
+from redi.api.attachment import upload_file
+from redi.client import client
+
+
+def list_files(project_id: str, full: bool = False) -> None:
+    response = client.get(f"/projects/{project_id}/files.json")
+    if response.status_code == 404:
+        print(f"プロジェクトが見つかりません: {project_id}")
+        exit(1)
+    response.raise_for_status()
+    files = response.json()["files"]
+    if full:
+        print(json.dumps(files, ensure_ascii=False))
+        return
+    for f in files:
+        version = f.get("version") or {}
+        version_label = f" [{version.get('name')}]" if version else ""
+        size = f.get("filesize", "")
+        print(f"{f['id']} {f['filename']} ({size}B){version_label}")
+
+
+def create_file(
+    project_id: str,
+    file_path: str,
+    version_id: int | None = None,
+    description: str | None = None,
+) -> None:
+    upload = upload_file(file_path)
+    file_data: dict = {
+        "token": upload["token"],
+        "filename": upload["filename"],
+        "content_type": upload["content_type"],
+    }
+    if version_id is not None:
+        file_data["version_id"] = version_id
+    if description is not None:
+        file_data["description"] = description
+    response = client.post(
+        f"/projects/{project_id}/files.json", json={"file": file_data}
+    )
+    if response.status_code == 404:
+        print(f"プロジェクトが見つかりません: {project_id}")
+        exit(1)
+    try:
+        response.raise_for_status()
+    except requests.exceptions.HTTPError as e:
+        print(e)
+        print(e.response.text)
+        print("ファイルのアップロードに失敗しました")
+        exit(1)
+    print(f"ファイルをアップロードしました: {upload['filename']}")