asana-api-cli 3.1.3__tar.gz → 3.3.0__tar.gz

{asana_api_cli-3.1.3/src/asana_api_cli.egg-info → asana_api_cli-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: asana-api-cli
-Version: 3.1.3
+Version: 3.3.0
 Summary: Command-line wrapper around the official Asana Python SDK
 Author: Masanao Izumo
 License-Expression: MIT
@@ -46,6 +46,9 @@ asana-api tasks get-tasks --project 123 --opt-fields name,assignee.name
 asana.TasksApi(client).get_tasks({"project": "123", "opt_fields": "name,assignee.name"})
 ```
 
+Or skip the translation entirely: `asana-api --generate-python …` writes that
+Python for you (see [Usage](#usage)).
+
 ## Why asana-api-cli
 
 - **Explore the whole API from the shell.** Every method of every `*Api`
@@ -132,7 +135,9 @@ automatically.
 
 The token can be issued from the
 [Asana Developer Console](https://app.asana.com/0/developer-console).
-No token is needed for `--help` or argument validation errors.
+No token is needed for `--help` or command-line parsing errors. (A `--query`
+jq filter is validated against the response, so it surfaces errors only after
+the API call — which does need a token.)
 
 ```bash
 export ASANA_ACCESS_TOKEN="2/12345..."
@@ -176,7 +181,7 @@ asana-api tasks get-tasks --help
 # List workspaces
 asana-api workspaces get-workspaces
 
-# List up to 50 projects
+# List up to 50 projects (workspace comes from $ASANA_DEFAULT_WORKSPACE)
 asana-api projects get-projects-for-workspace --item-limit 50
 asana-api projects get-projects --workspace <WORKSPACE_GID> --item-limit 50
 
@@ -195,10 +200,11 @@ asana-api tasks get-task --task <TASK_GID>
 # Create a task (body is a JSON string)
 asana-api tasks create-task --body '{"data":{"name":"new task","projects":["<PROJECT_GID>"]}}'
 
-# Output formats — pair non-JSON formats with `--query '.data'` to unwrap the
-# `{"data": [...]}` envelope into one row per item.
-asana-api tasks get-tasks --project <PROJECT_GID> --query '.data' --output table
-asana-api tasks get-tasks --project <PROJECT_GID> --query '.data' --output csv
+# Output formats — non-JSON formats render one row per item. The default
+# auto-paginating output is a flat list, so it is directly rowable; under
+# --full-payload, unwrap the `{"data": [...]}` envelope first with `--query '.data'`.
+asana-api tasks get-tasks --project <PROJECT_GID> --output table
+asana-api tasks get-tasks --project <PROJECT_GID> --full-payload --query '.data' --output csv
 
 # CSV output is UTF-8 without a BOM by default. Pass --csv-bom for Excel on
 # Windows, which otherwise displays non-ASCII characters as garbled text.
@@ -210,6 +216,40 @@ asana-api tasks get-tasks --project <PROJECT_GID> --output csv --csv-bom > tasks
 asana-api tasks delete-task --task <TASK_GID> --output none
 ```
 
+Don't hand-translate the call yourself — `--generate-python` does it for you. It
+prints a standalone `python-asana` script equivalent to the command instead of
+running it (no token, no network), turning a working shell call into
+ready-to-paste SDK code:
+
+```bash
+asana-api --generate-python tasks get-task --task <TASK_GID>
+```
+
+```python
+# Generated equivalent (header and stdio-setup boilerplate trimmed):
+import json
+import os
+
+import asana
+
+configuration = asana.Configuration()
+configuration.access_token = os.environ['ASANA_ACCESS_TOKEN']
+api_client = asana.ApiClient(configuration)
+
+api_instance = asana.TasksApi(api_client)
+opts = {}
+
+result = api_instance.get_task('<TASK_GID>', opts)
+
+print(json.dumps(result, indent=2, ensure_ascii=False))
+```
+
+Redirect it to a file (`asana-api … --generate-python > fetch_task.py`) to keep
+the script. It reproduces your configuration, output format, `--query`, `--debug`
+(with the auth token masked), and uploads — see
+[Generating Python code](https://github.com/izumo-m/asana-api-cli/blob/main/docs/usage.md#generating-python-code)
+for the full behavior.
+
 For the complete option reference — global options, pagination, output formats,
 workspace resolution, error handling, and exit codes — see
 [`docs/usage.md`](https://github.com/izumo-m/asana-api-cli/blob/main/docs/usage.md).

{asana_api_cli-3.1.3 → asana_api_cli-3.3.0}/README.md

@@ -18,6 +18,9 @@ asana-api tasks get-tasks --project 123 --opt-fields name,assignee.name
 asana.TasksApi(client).get_tasks({"project": "123", "opt_fields": "name,assignee.name"})
 ```
 
+Or skip the translation entirely: `asana-api --generate-python …` writes that
+Python for you (see [Usage](#usage)).
+
 ## Why asana-api-cli
 
 - **Explore the whole API from the shell.** Every method of every `*Api`
@@ -104,7 +107,9 @@ automatically.
 
 The token can be issued from the
 [Asana Developer Console](https://app.asana.com/0/developer-console).
-No token is needed for `--help` or argument validation errors.
+No token is needed for `--help` or command-line parsing errors. (A `--query`
+jq filter is validated against the response, so it surfaces errors only after
+the API call — which does need a token.)
 
 ```bash
 export ASANA_ACCESS_TOKEN="2/12345..."
@@ -148,7 +153,7 @@ asana-api tasks get-tasks --help
 # List workspaces
 asana-api workspaces get-workspaces
 
-# List up to 50 projects
+# List up to 50 projects (workspace comes from $ASANA_DEFAULT_WORKSPACE)
 asana-api projects get-projects-for-workspace --item-limit 50
 asana-api projects get-projects --workspace <WORKSPACE_GID> --item-limit 50
 
@@ -167,10 +172,11 @@ asana-api tasks get-task --task <TASK_GID>
 # Create a task (body is a JSON string)
 asana-api tasks create-task --body '{"data":{"name":"new task","projects":["<PROJECT_GID>"]}}'
 
-# Output formats — pair non-JSON formats with `--query '.data'` to unwrap the
-# `{"data": [...]}` envelope into one row per item.
-asana-api tasks get-tasks --project <PROJECT_GID> --query '.data' --output table
-asana-api tasks get-tasks --project <PROJECT_GID> --query '.data' --output csv
+# Output formats — non-JSON formats render one row per item. The default
+# auto-paginating output is a flat list, so it is directly rowable; under
+# --full-payload, unwrap the `{"data": [...]}` envelope first with `--query '.data'`.
+asana-api tasks get-tasks --project <PROJECT_GID> --output table
+asana-api tasks get-tasks --project <PROJECT_GID> --full-payload --query '.data' --output csv
 
 # CSV output is UTF-8 without a BOM by default. Pass --csv-bom for Excel on
 # Windows, which otherwise displays non-ASCII characters as garbled text.
@@ -182,6 +188,40 @@ asana-api tasks get-tasks --project <PROJECT_GID> --output csv --csv-bom > tasks
 asana-api tasks delete-task --task <TASK_GID> --output none
 ```
 
+Don't hand-translate the call yourself — `--generate-python` does it for you. It
+prints a standalone `python-asana` script equivalent to the command instead of
+running it (no token, no network), turning a working shell call into
+ready-to-paste SDK code:
+
+```bash
+asana-api --generate-python tasks get-task --task <TASK_GID>
+```
+
+```python
+# Generated equivalent (header and stdio-setup boilerplate trimmed):
+import json
+import os
+
+import asana
+
+configuration = asana.Configuration()
+configuration.access_token = os.environ['ASANA_ACCESS_TOKEN']
+api_client = asana.ApiClient(configuration)
+
+api_instance = asana.TasksApi(api_client)
+opts = {}
+
+result = api_instance.get_task('<TASK_GID>', opts)
+
+print(json.dumps(result, indent=2, ensure_ascii=False))
+```
+
+Redirect it to a file (`asana-api … --generate-python > fetch_task.py`) to keep
+the script. It reproduces your configuration, output format, `--query`, `--debug`
+(with the auth token masked), and uploads — see
+[Generating Python code](https://github.com/izumo-m/asana-api-cli/blob/main/docs/usage.md#generating-python-code)
+for the full behavior.
+
 For the complete option reference — global options, pagination, output formats,
 workspace resolution, error handling, and exit codes — see
 [`docs/usage.md`](https://github.com/izumo-m/asana-api-cli/blob/main/docs/usage.md).

{asana_api_cli-3.1.3 → asana_api_cli-3.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "asana-api-cli"
-version = "3.1.3"
+version = "3.3.0"
 description = "Command-line wrapper around the official Asana Python SDK"
 authors = [{name = "Masanao Izumo"}]
 readme = "README.md"
@@ -55,6 +55,10 @@ where = ["src"]
 [tool.ruff]
 target-version = "py310"
 line-length = 100
+# Generated python-asana scripts pinned as golden snapshots; they use repr/pprint
+# literal style and are validated by ``compile()`` in the snapshot test, not by
+# this project's lint config.
+extend-exclude = ["tests/fixtures/generate_python"]
 
 [tool.ruff.format]
 docstring-code-format = true