ktr-cli 0.1.0__py3-none-any.whl

ktr_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: ktr-cli
+Version: 0.1.0
+Summary: Unofficial command-line client for the Kantree API.
+Author: Sebastien De Reviere
+License-Expression: Apache-2.0
+Requires-Dist: click>=8.3,<9
+Requires-Dist: requests>=2.33,<3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# ktr-cli
+
+Unofficial command-line client for the Kantree API.
+
+This project is not affiliated with, endorsed by, or maintained by Kantree.
+
+`ktr-cli` exposes:
+
+* `kantree`: canonical command
+* `ktr`: short alias
+
+Commands are organized around Kantree workflows: auth, discovery (`org`, `team`,
+`workspace`, `view`), cards, search, import/export, webhooks, automations, and
+raw endpoint testing.
+
+## Install and run
+
+* Python `3.11+`
+* `uv`
+* A Kantree API key (`X-Api-Key`)
+
+From PyPI:
+
+```bash
+uv tool install ktr-cli
+kantree --help
+ktr --help
+```
+
+From the repository root:
+
+```bash
+uv venv
+uv sync --group dev
+uv run kantree --help
+uv run ktr --help
+```
+
+To run checks locally:
+
+```bash
+uv run pytest
+gate
+```
+
+Real API smoke tests are opt-in only. See
+`docs/guides/real-api-smoke-testing.md`.
+
+## First auth setup
+
+```bash
+export KANTREE_API_KEY="..."
+uv run kantree auth init
+uv run kantree auth set \
+  --profile work \
+  --base-url https://kantree.io/api/1.0 \
+  --api-key-env KANTREE_API_KEY
+uv run kantree auth use work
+uv run kantree auth test
+uv run kantree me
+```
+
+`auth set` stores profile metadata only; the key value is never printed. Use
+`uv run kantree auth` or `uv run kantree auth show` to inspect active profile
+state and defaults.
+
+Config path:
+
+* `$XDG_CONFIG_HOME/kantree/config.toml` if `XDG_CONFIG_HOME` is set
+* `~/.config/kantree/config.toml` otherwise
+
+## Workspace-aware usage
+
+Most commands need a workspace. Use one of:
+
+```bash
+uv run kantree card list --workspace Ops
+uv run kantree card list --workspace-id 42
+uv run kantree --workspace Ops card list
+KANTREE_WORKSPACE=Ops uv run kantree card list
+```
+
+Resolution order:
+
+1. Command-local `--workspace-id` / `--workspace`
+2. Root `kantree --workspace-id` / `--workspace`
+3. `KANTREE_WORKSPACE_ID` / `KANTREE_WORKSPACE`
+4. Active profile `default_workspace`
+
+If a command depends on a workspace, command-local wins.
+
+Set defaults per profile:
+
+```bash
+uv run kantree workspace use Ops
+uv run kantree workspace current
+uv run kantree workspace current --resolve-remote
+```
+
+Delete commands are stricter and require explicit selectors.
+
+```bash
+uv run kantree workspace delete --workspace-id 42 --yes
+```
+
+## Output format
+
+Default output is JSON. List-style commands support:
+
+* `table`
+* `tsv`
+* `ids`
+* `ndjson`
+
+Use:
+
+```bash
+uv run kantree --format table workspace list
+uv run kantree --format tsv --fields id,title,state card list --workspace Ops
+uv run kantree --format ids card list --workspace Ops
+```
+
+`--verbose` enables extra columns when supported.
+
+## Common command groups
+
+```bash
+uv run kantree org list
+uv run kantree workspace list --org DSI
+uv run kantree team list --org DSI
+uv run kantree card list --workspace Ops --filter '@me'
+uv run kantree card create --workspace Ops --title "Fix LDAP sync"
+uv run kantree card edit 123 --state completed
+uv run kantree search cards --query '@me'
+uv run kantree search preset list
+uv run kantree view list
+uv run kantree webhook list --workspace Ops
+uv run kantree automation list --workspace Ops
+uv run kantree import ./cards.csv
+uv run kantree kql validate '@me and state!=completed'
+uv run kantree api request GET /me
+```
+
+Use `uv run kantree --help` and command-level `--help` for current flags and
+subcommand details.
+
+## Safety notes
+
+* Keep API keys in env vars or a secret manager.
+* `auth show` redacts key metadata only; avoid command-line secrets (`--body`)
+  in shared terminals and history.
+* Destructive commands and some destructive batches require explicit `--yes`.
+* `workspace delete` ignores default workspace fallbacks and requires explicit
+  selector.
+* Prefer `card archive` when you need a reversible action.
+* Use `--dry-run` where available before mutating commands.
+
+## Where to continue
+
+* `docs/README.md`
+* `docs/style.md`
+* `docs/guides/real-api-smoke-testing.md`

ktr_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+kantree_cli/__init__.py,sha256=Y2gVcE_sRBLoh8iXnMc3_NdR3U5nob1Ll9rlkuwd6qs,61
+kantree_cli/cli.py,sha256=yNDG_ffIbNBsUsZv0oaoO6se0llQc_wrMslWth-ia8o,264345
+kantree_cli/core/__init__.py,sha256=FQMMj4gKb26ET_cnZBJdhISJNMWucmQqHwNjZTwxhSM,40
+kantree_cli/core/client.py,sha256=VNQ0o0AyH9yGOBmhPv0h7MEfuLl2szwUoQ6bmM_pfIQ,8265
+kantree_cli/core/config.py,sha256=xbYl7JkZbcSBVgiHBpAOf4II1kHyZLJ9FgmA9WYsoxM,7575
+kantree_cli/core/context.py,sha256=CLn43rM8gvt12i4z3Nuzo8_dYqjLWt9ma9TZhaqaCS0,4644
+kantree_cli/core/errors.py,sha256=0humRvCkdlItUVKTeyN_9Ygoa6zKYRR7pAxjRmLM8IU,506
+kantree_cli/core/output.py,sha256=I3Mmcb8kFiEcZaCmMjQk1xV6RNlvgSAsBy2mP3KWJ2w,2007
+kantree_cli/core/response.py,sha256=n17MreS3PvTnDahO-L6_eRNN00uyZhZ3p9QnMWVqMpw,2513
+kantree_cli/services/__init__.py,sha256=_mSHedwEQ_39oBTt2j1fCbvIMHPaMAk9Cgl_W4_hB5w,51
+kantree_cli/services/cards.py,sha256=JfwlhW6g8vMDEGmfnIw91acgQps_EZZS_shnmgJyeq8,20753
+kantree_cli/services/importers.py,sha256=eNnun33kfbhQ4YBWhU-t54PJXh9UjqAJOpnh6K7135Y,9930
+kantree_cli/services/kql.py,sha256=9l2bHvFTo6GJKkWDRK-Sr4qB_IpGzn8huZhKLNHqf_k,1375
+kantree_cli/services/resolver.py,sha256=j0-8XGUuWVdRcP3l8y2k8rC4aE8vyv2kaEDexB_4s0g,7670
+kantree_cli/services/search.py,sha256=fLdvqvGwpzJoL2SwTP5IzN9zKptPX7NnwM18KfBwAjg,2460
+kantree_cli/services/views.py,sha256=A1PUgfQicxBghzTpdi2qLEw4ttA5L52cay9V-qmFpvM,3940
+kantree_cli/services/webhooks.py,sha256=Jw0N9oy1jUGfrUuvxFu_qcK-OMCT0wVghSzROmo8N5I,3567
+kantree_cli/services/workspaces.py,sha256=jWAl9DU1ORepVI2KQrRzIil57ln0OmxdDMl8qH_9Wco,38441
+ktr_cli-0.1.0.dist-info/WHEEL,sha256=fWriCkzqm-pffF5af4gJC9iI5FMFaJTuN9UxxxzOmdY,81
+ktr_cli-0.1.0.dist-info/entry_points.txt,sha256=ihcIRGaP7TvQ1FaSgXsnCDBurimSg_aemXR9kbYpycM,77
+ktr_cli-0.1.0.dist-info/METADATA,sha256=BAfw7iO0DthDp3lM0wcy0FUdowp3h3TFyQ9EJmGiNaA,4136
+ktr_cli-0.1.0.dist-info/RECORD,,

ktr_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.14
+Root-Is-Purelib: true
+Tag: py3-none-any

ktr_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+kantree = kantree_cli.cli:main
+ktr = kantree_cli.cli:main
+