papycli 0.4.0__tar.gz

papycli-0.4.0/.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash"
+    ]
+  }
+}

papycli-0.4.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

papycli-0.4.0/.python-version

@@ -0,0 +1 @@
+3.12

papycli-0.4.0/CLAUDE.md

@@ -0,0 +1,191 @@
+# CLAUDE.md
+
+## プロジェクト概要
+
+`papycli` は OpenAPI 3.0 仕様を読み込み、REST API エンドポイントをターミナルから直接呼び出せるインタラクティブな CLI を提供する Python 製ツールです。
+
+---
+
+## 開発環境
+
+- Python 3.12 以上
+- 依存ライブラリは `pyproject.toml` で管理する
+
+### セットアップ
+
+```bash
+pip install -e ".[dev]"
+```
+
+### 開発用ツール
+
+| ツール | 用途 |
+|--------|------|
+| `pytest` | テスト実行 |
+| `ruff` | Lint + フォーマット |
+| `mypy` | 型チェック |
+
+---
+
+## アーキテクチャ
+
+### ディレクトリ構成
+
+```
+papycli/
+├── src/
+│   └── papycli/
+│       ├── __init__.py
+│       ├── main.py          # エントリポイント・引数パース
+│       ├── init_cmd.py      # --init コマンド（spec の変換・保存）
+│       ├── api_call.py      # HTTP リクエスト実行
+│       ├── completion.py    # シェル補完スクリプト生成
+│       ├── config.py        # 設定ファイルの読み書き
+│       ├── spec_loader.py   # OpenAPI spec の読み込み・$ref 解決
+│       └── summary.py       # --summary / --summary-csv
+├── tests/
+├── examples/
+│   ├── docker-compose.yml
+│   └── petstore-oas3.json
+├── pyproject.toml
+├── README.md
+└── CLAUDE.md
+```
+
+### 主要モジュール
+
+**`main.py`** — CLI エントリポイント
+引数をパースし、各コマンド（`init`、`use`、`conf`、`summary`、`completion-script`、メソッド呼び出し）に処理を委譲する。シェル補完用の `_complete` 内部コマンドもここで定義する。
+
+**`init_cmd.py`** — API 初期化
+OpenAPI spec ファイルを受け取り、`$ref` を解決した上で papycli 内部の API 定義フォーマットに変換し、`$PAPYCLI_CONF_DIR/apis/<name>.json` に保存する。設定ファイル (`papycli.conf`) も更新する。
+
+**`spec_loader.py`** — spec 読み込み・変換
+OpenAPI spec の JSON/YAML を読み込み、`$ref` を再帰的に解決して、papycli の内部フォーマット（後述）に変換する。Python 標準ライブラリのみ（または最小限の依存）で実装する。
+
+**`api_call.py`** — HTTP リクエスト実行
+メソッド・リソースパス・オプションを受け取り、`requests` ライブラリで HTTP リクエストを実行する。パステンプレート（`/pet/{petId}`）のマッチングと値の埋め込みも担当する。
+
+**`completion.py`** — シェル補完
+bash / zsh 向けの補完スクリプトを生成する。補完の候補はメソッド、リソースパス、パラメータ名、enum 値の順にコンテキストに応じて提供する。
+
+**`config.py`** — 設定管理
+`papycli.conf` の読み書きと、`PAPYCLI_CONF_DIR` 環境変数の解決を行う。
+
+**`summary.py`** — サマリー表示
+登録済み API のエンドポイント一覧を整形して出力する。`--summary-csv` では CSV 形式で出力する。
+
+---
+
+## 内部データフォーマット
+
+### API 定義ファイル (`apis/<name>.json`)
+
+```json
+{
+  "/pet": [
+    {
+      "method": "post",
+      "query_parameters": [],
+      "post_parameters": [
+        {"name": "name", "type": "string", "required": true},
+        {"name": "status", "type": "string", "required": false, "enum": ["available", "pending", "sold"]},
+        {"name": "photoUrls", "type": "array", "required": true}
+      ]
+    }
+  ],
+  "/pet/findByStatus": [
+    {
+      "method": "get",
+      "query_parameters": [
+        {"name": "status", "type": "string", "required": false, "enum": ["available", "pending", "sold"]}
+      ],
+      "post_parameters": []
+    }
+  ],
+  "/pet/{petId}": [
+    {
+      "method": "get",
+      "query_parameters": [],
+      "post_parameters": []
+    },
+    {
+      "method": "delete",
+      "query_parameters": [],
+      "post_parameters": []
+    }
+  ]
+}
+```
+
+### 設定ファイル (`papycli.conf`)
+
+```json
+{
+  "default": "petstore",
+  "petstore": {
+    "openapispec": "petstore.json",
+    "apidef": "petstore.json",
+    "url": "http://localhost:8080/api/v3"
+  }
+}
+```
+
+---
+
+## CLI 仕様
+
+### コマンド構文
+
+```
+papycli <method> <resource> [options]
+papycli init <spec-file>
+papycli use <api-name>
+papycli conf
+papycli summary [resource] [--csv]
+papycli completion-script <bash|zsh>
+papycli --version
+papycli --help / -h
+```
+
+### サポートするメソッド
+
+`get | post | put | patch | delete` をサポートする。
+
+### パラメータ処理
+
+- `-q <name> <value>` — URL クエリパラメータ。同じ名前を繰り返し可能（`?status=a&status=b`）
+- `-p <name> <value>` — JSON ボディパラメータ。同じキーを繰り返すと配列を構築する
+- `-p <name.subname> <value>` — ドット記法で 1 レベルのネストオブジェクトを構築する
+- `-d <json>` — 生の JSON 文字列。`-p` オプションを上書きする
+- `-H <header: value>` — カスタム HTTP ヘッダー
+
+### パステンプレートのマッチング
+
+リソースパスに数値や文字列が含まれる場合（例：`/pet/99`）、API 定義内のテンプレート（`/pet/{petId}`）にマッチさせ、値を埋め込んでリクエストを送信する。
+
+---
+
+## 環境変数
+
+| 変数 | デフォルト | 説明 |
+|------|-----------|------|
+| `PAPYCLI_CONF_DIR` | `~/.papycli` | 設定ディレクトリのパス |
+| `PAPYCLI_CUSTOM_HEADER` | （なし） | 全リクエストに付与するカスタムヘッダー（改行区切りで複数指定可） |
+
+---
+
+## テスト方針
+
+- `tests/` 以下にユニットテストを配置する
+- HTTP リクエストは `responses` ライブラリ等でモックして実テストしない
+- OpenAPI spec の変換ロジックは代表的なケースを網羅するテストを書く
+
+---
+
+## コーディング規約
+
+- フォーマッタ・Lint は `ruff` を使用する
+- 型ヒントを積極的に使用し、`mypy` でチェックを通す
+- 関数・モジュールの公開 API にのみ docstring を書く（内部実装には不要）
+- エラーメッセージはユーザーが原因を特定しやすい内容にする

papycli-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Taro Monji
+
+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.

papycli-0.4.0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: papycli
+Version: 0.4.0
+Summary: A CLI tool to call REST APIs defined in OpenAPI 3.0 specs
+Project-URL: Homepage, https://github.com/tmonj1/papycli
+Project-URL: Repository, https://github.com/tmonj1/papycli
+Project-URL: Bug Tracker, https://github.com/tmonj1/papycli/issues
+Author-email: tmonj1 <tmonj1@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: api,cli,http,openapi,rest
+Classifier: Development Status :: 3 - Alpha
+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.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: requests>=2.32
+Requires-Dist: rich>=13.0
+Description-Content-Type: text/markdown
+
+# papycli — Python CLI for OpenAPI 3.0 REST APIs
+
+`papycli` is an interactive CLI that reads OpenAPI 3.0 specs and lets you call REST API endpoints directly from the terminal.
+
+## Features
+
+- Auto-generates a CLI from any OpenAPI 3.0 spec
+- Shell completion for bash and zsh
+- Register and switch between multiple APIs
+
+## Requirements
+
+| Item | Notes |
+|------|-------|
+| Python | 3.12 or later |
+
+No external tools (e.g. `jq`) required. Works with Python and pip alone.
+
+---
+
+## Installation
+
+```bash
+pip install papycli
+```
+
+### Enable Shell Completion
+
+**bash:**
+
+```bash
+# Add to ~/.bashrc or ~/.bash_profile
+eval "$(papycli completion-script bash)"
+```
+
+**zsh:**
+
+```bash
+# Add to ~/.zshrc
+eval "$(papycli completion-script zsh)"
+```
+
+Restart your shell or run `source ~/.bashrc` / `source ~/.zshrc` to apply.
+
+---
+
+## Quick Start — Petstore Demo
+
+This repository includes a demo using the [Swagger Petstore](https://github.com/swagger-api/swagger-petstore).
+
+### 1. Start the Petstore server
+
+```bash
+docker compose -f examples/docker-compose.yml up -d
+```
+
+The API will be available at `http://localhost:8080/api/v3/`.
+
+### 2. Register the API
+
+```bash
+papycli init examples/petstore-oas3.json
+```
+
+### 3. Try some commands
+
+```bash
+# List available endpoints
+papycli summary
+
+# GET /store/inventory
+papycli get /store/inventory
+
+# GET with a path parameter
+papycli get /pet/99
+
+# GET with a query parameter
+papycli get /pet/findByStatus -q status available
+
+# POST with body parameters
+papycli post /pet -p name "My Dog" -p status available -p photoUrls "http://example.com/photo.jpg"
+
+# POST with a raw JSON body
+papycli post /pet -d '{"name": "My Dog", "status": "available", "photoUrls": ["http://example.com/photo.jpg"]}'
+
+# Array parameter (repeat the same key)
+papycli put /pet -p id 1 -p name "My Dog" -p photoUrls "http://example.com/a.jpg" -p photoUrls "http://example.com/b.jpg" -p status available
+
+# Nested object (dot notation)
+papycli put /pet -p id 1 -p name "My Dog" -p category.id 2 -p category.name "Dogs" -p photoUrls "http://example.com/photo.jpg" -p status available
+
+# DELETE /pet/{petId}
+papycli delete /pet/1
+```
+
+### 4. Tab completion
+
+Once shell completion is enabled, tab completion is available:
+
+```
+$ papycli <TAB>
+  get  post  put  delete  patch
+
+$ papycli get <TAB>
+  /pet/findByStatus  /pet/{petId}  /store/inventory  ...
+
+$ papycli get /pet/findByStatus <TAB>
+  -q  --summary  --help
+
+$ papycli get /pet/findByStatus -q <TAB>
+  status
+
+$ papycli get /pet/findByStatus -q status <TAB>
+  available  pending  sold
+```
+
+---
+
+## Adding Your Own API
+
+### Step 1 — Run `init`
+
+```bash
+papycli init your-api-spec.json
+```
+
+This command will:
+
+1. Resolve all `$ref` references in the OpenAPI spec
+2. Convert the spec to papycli's internal API definition format
+3. Save the result to `$PAPYCLI_CONF_DIR/apis/<name>.json`
+4. Create or update `$PAPYCLI_CONF_DIR/papycli.conf`
+
+The API name is derived from the filename (e.g. `your-api-spec.json` → `your-api-spec`).
+
+### Step 2 — Set the base URL
+
+If the spec contains `servers[0].url`, it is used automatically. Otherwise, edit `$PAPYCLI_CONF_DIR/papycli.conf` and set the `url` field:
+
+```json
+{
+  "default": "your-api-spec",
+  "your-api-spec": {
+    "openapispec": "your-api-spec.json",
+    "apidef": "your-api-spec.json",
+    "url": "https://your-api-base-url/"
+  }
+}
+```
+
+### Managing Multiple APIs
+
+```bash
+# Register multiple APIs
+papycli init petstore-oas3.json
+papycli init myapi.json
+
+# Switch the active API
+papycli use myapi
+
+# Show registered APIs and the current default
+papycli conf
+```
+
+---
+
+## Reference
+
+```
+# API management commands
+papycli init <spec-file>            Initialize an API from an OpenAPI spec file
+papycli use <api-name>              Switch the active API
+papycli conf                        Show current configuration
+papycli summary [resource]          List available endpoints (filter by resource prefix)
+                                      Required params marked with *, array params with []
+papycli summary --csv               Output endpoints in CSV format
+papycli completion-script <bash|zsh>  Print a shell completion script
+
+# API call commands
+papycli <method> <resource> [options]
+
+Methods:
+  get | post | put | patch | delete
+
+Options:
+  -H <header: value>      Custom HTTP header (repeatable)
+  -q <name> <value>       Query parameter (repeatable)
+  -p <name> <value>       Body parameter (repeatable)
+                            - Repeat the same key to build a JSON array:
+                              -p tags foo -p tags bar  →  {"tags":["foo","bar"]}
+                            - Use dot notation to build a nested object:
+                              -p category.id 1 -p category.name Dogs
+                              →  {"category":{"id":"1","name":"Dogs"}}
+  -d <json>               Raw JSON body (overrides -p)
+  --summary               Show endpoint info without sending a request
+  --version               Show version
+  --help / -h             Show help
+
+Environment variables:
+  PAPYCLI_CONF_DIR        Path to the config directory (default: ~/.papycli)
+  PAPYCLI_CUSTOM_HEADER   Custom HTTP headers applied to every request.
+                            Separate multiple headers with newlines:
+                            export PAPYCLI_CUSTOM_HEADER=$'Authorization: Bearer token\nX-Tenant: acme'
+```
+
+---
+
+## Limitations
+
+- Request bodies are `application/json` only
+- Array parameters support scalar element types only (arrays of objects are not supported)
+- Dot notation for nested objects supports one level of nesting only
+- Pass auth headers via `-H "Authorization: Bearer token"` or the `PAPYCLI_CUSTOM_HEADER` env var
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/tmonj1/papycli.git
+cd papycli
+pip install -e ".[dev]"
+```
+
+See [CLAUDE.md](CLAUDE.md) for details.