asana-api-cli 1.5.0__tar.gz → 2.0.0__tar.gz

{asana_api_cli-1.5.0/src/asana_api_cli.egg-info → asana_api_cli-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asana-api-cli
-Version: 1.5.0
+Version: 2.0.0
 Summary: Command-line wrapper around the official Asana Python SDK
 Author-email: Masanao Izumo <asana@masanao.site>
 License-Expression: MIT
@@ -11,27 +11,96 @@ Project-URL: Changelog, https://github.com/izumo-m/asana-api-cli/blob/main/CHANG
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: click<9,>=8.1
-Requires-Dist: jq<2,>=1.8
-Requires-Dist: tabulate<1,>=0.9
-Requires-Dist: asana<6,>=5.2.4
+Requires-Dist: click>=8.0
+Requires-Dist: jq>=1.5
+Requires-Dist: tabulate>=0.9
+Requires-Dist: asana<6,>=5.2
 Dynamic: license-file
 
 # asana-api-cli
 
-A CLI tool for the Asana API. It thinly wraps the official
+A CLI for the Asana API. It thinly wraps the official
 [python-asana](https://github.com/Asana/python-asana) SDK with click, exposing
-every API endpoint from the command line via `asana-api <group> <command>`.
+every endpoint as `asana-api <group> <command>`.
+
+## Why asana-api-cli
+
+- **Near-complete SDK coverage.** Almost every method on every `*Api` class in
+  python-asana is available as a CLI command. The command tree is built at
+  runtime from the installed `asana` package, so new APIs surface as the
+  upstream library evolves — no asana-api-cli release required.
+- **Tracks the SDK version you actually use.** Because commands are
+  introspected from whatever `asana` is installed alongside, the CLI surface
+  matches the SDK version pinned in your project. When using asana-api-cli
+  as a dev-dependency, `pip install -U asana` updates the CLI's available
+  endpoints in lockstep with your application code.
+- **SDK-compatible arguments and output.** Command arguments map to
+  python-asana method parameters (with minor naming adjustments — hyphens
+  become underscores, group names become PascalCase API classes), and JSON
+  output matches the SDK's response shape. The CLI makes it easy to iterate:
+  try different arguments, inspect the response, and refine until you
+  understand the endpoint's behavior. Once verified, port the call into your
+  Python app — far fewer surprises on the first integration.
 
 ## Installation
 
 ```bash
 pip install asana-api-cli
+```
+
+For best results, install asana-api-cli into the same Python environment
+that holds your project's `python-asana` so the CLI surface tracks the
+exact SDK version your application uses (see [As a
+dev-dependency](#as-a-dev-dependency) below).
+
+### As a dev-dependency
+
+If your project already uses `python-asana`, add asana-api-cli to your dev
+group so the CLI tracks the same SDK version your application code uses:
+
+```toml
+# pyproject.toml
+[project]
+dependencies = ["asana>=5.2,<6"]
+
+[dependency-groups]  # uv
+dev = ["asana-api-cli"]
+```
+
+```toml
+# Poetry
+[tool.poetry.group.dev.dependencies]
+asana-api-cli = "*"
+```
 
-# or, to install as an isolated CLI tool
+After `uv sync` (or equivalent), `asana-api` resolves to the project's
+`.venv` and introspects whatever `asana` version is locked there. Tests
+prototyped with `asana-api tasks ...` will exactly match the SDK calls in
+your app.
+
+### Installing globally with pipx
+
+If you would rather isolate asana-api-cli from any project's dependencies
+— for example, when you administer Asana from the shell without writing
+Python — install it with [pipx](https://pipx.pypa.io/):
+
+```bash
 pipx install asana-api-cli
 ```
 
+In this setup the CLI uses the `python-asana` version that shipped with
+the asana-api-cli release; `pipx upgrade asana-api-cli` updates only
+asana-api-cli itself, not the bundled `python-asana`. To pull a newer
+`python-asana` into the existing pipx install without reinstalling the
+CLI:
+
+```bash
+pipx runpip asana-api-cli install -U asana
+```
+
+The next `asana-api` run sees the new SDK and any newly added endpoints
+automatically.
+
 ## Environment variables
 
 | Name | Required | Description |

{asana_api_cli-1.5.0 → asana_api_cli-2.0.0}/README.md

@@ -1,18 +1,87 @@
 # asana-api-cli
 
-A CLI tool for the Asana API. It thinly wraps the official
+A CLI for the Asana API. It thinly wraps the official
 [python-asana](https://github.com/Asana/python-asana) SDK with click, exposing
-every API endpoint from the command line via `asana-api <group> <command>`.
+every endpoint as `asana-api <group> <command>`.
+
+## Why asana-api-cli
+
+- **Near-complete SDK coverage.** Almost every method on every `*Api` class in
+  python-asana is available as a CLI command. The command tree is built at
+  runtime from the installed `asana` package, so new APIs surface as the
+  upstream library evolves — no asana-api-cli release required.
+- **Tracks the SDK version you actually use.** Because commands are
+  introspected from whatever `asana` is installed alongside, the CLI surface
+  matches the SDK version pinned in your project. When using asana-api-cli
+  as a dev-dependency, `pip install -U asana` updates the CLI's available
+  endpoints in lockstep with your application code.
+- **SDK-compatible arguments and output.** Command arguments map to
+  python-asana method parameters (with minor naming adjustments — hyphens
+  become underscores, group names become PascalCase API classes), and JSON
+  output matches the SDK's response shape. The CLI makes it easy to iterate:
+  try different arguments, inspect the response, and refine until you
+  understand the endpoint's behavior. Once verified, port the call into your
+  Python app — far fewer surprises on the first integration.
 
 ## Installation
 
 ```bash
 pip install asana-api-cli
+```
+
+For best results, install asana-api-cli into the same Python environment
+that holds your project's `python-asana` so the CLI surface tracks the
+exact SDK version your application uses (see [As a
+dev-dependency](#as-a-dev-dependency) below).
+
+### As a dev-dependency
+
+If your project already uses `python-asana`, add asana-api-cli to your dev
+group so the CLI tracks the same SDK version your application code uses:
+
+```toml
+# pyproject.toml
+[project]
+dependencies = ["asana>=5.2,<6"]
+
+[dependency-groups]  # uv
+dev = ["asana-api-cli"]
+```
+
+```toml
+# Poetry
+[tool.poetry.group.dev.dependencies]
+asana-api-cli = "*"
+```
 
-# or, to install as an isolated CLI tool
+After `uv sync` (or equivalent), `asana-api` resolves to the project's
+`.venv` and introspects whatever `asana` version is locked there. Tests
+prototyped with `asana-api tasks ...` will exactly match the SDK calls in
+your app.
+
+### Installing globally with pipx
+
+If you would rather isolate asana-api-cli from any project's dependencies
+— for example, when you administer Asana from the shell without writing
+Python — install it with [pipx](https://pipx.pypa.io/):
+
+```bash
 pipx install asana-api-cli
 ```
 
+In this setup the CLI uses the `python-asana` version that shipped with
+the asana-api-cli release; `pipx upgrade asana-api-cli` updates only
+asana-api-cli itself, not the bundled `python-asana`. To pull a newer
+`python-asana` into the existing pipx install without reinstalling the
+CLI:
+
+```bash
+pipx runpip asana-api-cli install -U asana
+```
+
+The next `asana-api` run sees the new SDK and any newly added endpoints
+automatically.
+
 ## Environment variables
 
 | Name | Required | Description |

{asana_api_cli-1.5.0 → asana_api_cli-2.0.0}/pyproject.toml

@@ -1,16 +1,16 @@
 [project]
 name = "asana-api-cli"
-version = "1.5.0"
+version = "2.0.0"
 description = "Command-line wrapper around the official Asana Python SDK"
 authors = [{name = "Masanao Izumo", email = "asana@masanao.site"}]
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.10"
 dependencies = [
-    "click>=8.1,<9",
-    "jq>=1.8,<2",
-    "tabulate>=0.9,<1",
-    "asana>=5.2.4,<6",
+    "click>=8.0",
+    "jq>=1.5",
+    "tabulate>=0.9",
+    "asana>=5.2,<6",
 ]
 
 [project.urls]
@@ -41,7 +41,6 @@ where = ["src"]
 [tool.ruff]
 target-version = "py310"
 line-length = 100
-extend-exclude = ["src/asana_api_cli/cli"]  # auto-generated (tools/codegen.py)
 
 [tool.ruff.format]
 docstring-code-format = true