podojo-cli 0.8.2__tar.gz → 0.8.3__tar.gz

{podojo_cli-0.8.2 → podojo_cli-0.8.3}/CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to the Podojo CLI will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com),
 and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [0.8.3] - 2026-05-14
+
+### Changed
+- Expanded the README with a full command reference, authentication/config docs, and setup notes for the `showreel` and `synth` extras.
+
 ## [0.8.2] - 2026-05-14
 
 ### Changed

podojo_cli-0.8.3/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: podojo-cli
+Version: 0.8.3
+Summary: CLI for the Podojo user research platform
+Project-URL: Homepage, https://github.com/podojo/cli-podojo
+Project-URL: Source, https://github.com/podojo/cli-podojo
+Project-URL: Issues, https://github.com/podojo/cli-podojo/issues
+Project-URL: Changelog, https://github.com/podojo/cli-podojo/blob/main/CHANGELOG.md
+Author-email: Jochen Ade <jochen.ade@podojo.com>
+License-Expression: MIT
+Keywords: cli,podojo,transcripts,user-research,ux-research
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Other Audience
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Requires-Dist: google-api-python-client>=2.0
+Requires-Dist: google-auth>=2.0
+Requires-Dist: httpx>=0.28
+Requires-Dist: keyring>=25.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: typer>=0.15
+Provides-Extra: synth
+Requires-Dist: playwright>=1.40; extra == 'synth'
+Description-Content-Type: text/markdown
+
+# podojo-cli
+
+Command-line tool for the [Podojo](https://podojo.com) user research platform.
+
+`podojo` lets UX researchers manage projects, upload and transcribe interviews,
+build unmoderated user tests, download research videos, cut showreels, and run
+synthetic test participants — all without leaving the terminal.
+
+## Installation
+
+```bash
+uv tool install podojo-cli
+```
+
+Or with pip:
+
+```bash
+pip install podojo-cli
+```
+
+Requires Python 3.12+. Some commands need extra tooling:
+
+- `showreel` requires [`ffmpeg`](https://ffmpeg.org/) on your `PATH` (`brew install ffmpeg`).
+- `synth` requires the optional `synth` extra: `pip install 'podojo-cli[synth]'` then `playwright install chromium`.
+
+## Authentication
+
+Log in once with your Podojo API key — it's stored in your system keychain:
+
+```bash
+podojo auth login            # prompts for the key
+podojo auth login --key XXX  # or pass it directly
+podojo auth logout           # remove the stored key
+```
+
+Configuration is read from, in order of precedence:
+
+1. Environment variables — `PODOJO_API_KEY`, `PODOJO_BASE_URL`
+2. `~/.podojo.toml`
+3. The system keyring (set by `podojo auth login`)
+
+## Usage
+
+```bash
+podojo --help            # top-level help
+podojo <group> --help    # help for a command group
+```
+
+### Projects
+
+```bash
+podojo projects list
+podojo projects create "Checkout Redesign" --brief "Q1 usability study"
+podojo projects upload-doc "Checkout Redesign" brief.md --type brief
+podojo projects get-doc "Checkout Redesign" --type final -o final-report.md
+```
+
+`upload-doc` accepts `brief` and `final` document types; `get-doc` also supports
+`agent`. Embedded images are stripped from markdown before upload.
+
+### Interviews & transcripts
+
+```bash
+podojo interviews upload session-03.mp4 --project "Checkout Redesign"
+podojo transcripts list "Checkout Redesign"
+podojo transcripts download "Checkout Redesign" <batch-id> -o transcript.txt
+```
+
+### Videos & showreels
+
+```bash
+podojo videos list "Checkout Redesign"
+podojo videos download <batch-id> -o clip.mp4
+podojo showreel create clips.json -o showreel.mp4
+```
+
+The showreel `clips.json` is a list of clips, each with `batch_id`,
+`participant`, `country`, `topic`, `start`, and `end` (`MM:SS` or `HH:MM:SS`).
+Each clip gets an auto-generated title card.
+
+### Unmoderated user tests
+
+```bash
+podojo usertests example > my-test.yaml   # print a template to start from
+podojo usertests validate my-test.yaml    # check it without creating
+podojo usertests create -f my-test.yaml
+podojo usertests list
+podojo usertests get checkout-usability-v1
+podojo usertests update checkout-usability-v1 -f changes.yaml
+podojo usertests delete checkout-usability-v1
+podojo usertests snippet                  # recorder script for self-hosted prototypes
+```
+
+### Synthetic participants
+
+The `synth` group drives a Playwright browser through a user test preview so an
+agent (e.g. Claude Code) can act as a synthetic participant:
+
+```bash
+podojo synth start checkout-usability-v1   # or a preview URL
+podojo synth state
+podojo synth click "Get Started"
+podojo synth fill "#answer" "It felt slow"
+podojo synth advance
+podojo synth stop
+```
+
+### Google Drive
+
+```bash
+podojo gdrive upload report.md --folder-id <id>
+podojo gdrive list --folder-id <id>
+```
+
+Requires a `credentials.json` service-account file in the current directory.
+
+## Links
+
+- [Source & issues](https://github.com/podojo/cli-podojo)
+- [Changelog](https://github.com/podojo/cli-podojo/blob/main/CHANGELOG.md)
+
+## License
+
+MIT

podojo_cli-0.8.3/README.md

@@ -0,0 +1,124 @@
+# podojo-cli
+
+Command-line tool for the [Podojo](https://podojo.com) user research platform.
+
+`podojo` lets UX researchers manage projects, upload and transcribe interviews,
+build unmoderated user tests, download research videos, cut showreels, and run
+synthetic test participants — all without leaving the terminal.
+
+## Installation
+
+```bash
+uv tool install podojo-cli
+```
+
+Or with pip:
+
+```bash
+pip install podojo-cli
+```
+
+Requires Python 3.12+. Some commands need extra tooling:
+
+- `showreel` requires [`ffmpeg`](https://ffmpeg.org/) on your `PATH` (`brew install ffmpeg`).
+- `synth` requires the optional `synth` extra: `pip install 'podojo-cli[synth]'` then `playwright install chromium`.
+
+## Authentication
+
+Log in once with your Podojo API key — it's stored in your system keychain:
+
+```bash
+podojo auth login            # prompts for the key
+podojo auth login --key XXX  # or pass it directly
+podojo auth logout           # remove the stored key
+```
+
+Configuration is read from, in order of precedence:
+
+1. Environment variables — `PODOJO_API_KEY`, `PODOJO_BASE_URL`
+2. `~/.podojo.toml`
+3. The system keyring (set by `podojo auth login`)
+
+## Usage
+
+```bash
+podojo --help            # top-level help
+podojo <group> --help    # help for a command group
+```
+
+### Projects
+
+```bash
+podojo projects list
+podojo projects create "Checkout Redesign" --brief "Q1 usability study"
+podojo projects upload-doc "Checkout Redesign" brief.md --type brief
+podojo projects get-doc "Checkout Redesign" --type final -o final-report.md
+```
+
+`upload-doc` accepts `brief` and `final` document types; `get-doc` also supports
+`agent`. Embedded images are stripped from markdown before upload.
+
+### Interviews & transcripts
+
+```bash
+podojo interviews upload session-03.mp4 --project "Checkout Redesign"
+podojo transcripts list "Checkout Redesign"
+podojo transcripts download "Checkout Redesign" <batch-id> -o transcript.txt
+```
+
+### Videos & showreels
+
+```bash
+podojo videos list "Checkout Redesign"
+podojo videos download <batch-id> -o clip.mp4
+podojo showreel create clips.json -o showreel.mp4
+```
+
+The showreel `clips.json` is a list of clips, each with `batch_id`,
+`participant`, `country`, `topic`, `start`, and `end` (`MM:SS` or `HH:MM:SS`).
+Each clip gets an auto-generated title card.
+
+### Unmoderated user tests
+
+```bash
+podojo usertests example > my-test.yaml   # print a template to start from
+podojo usertests validate my-test.yaml    # check it without creating
+podojo usertests create -f my-test.yaml
+podojo usertests list
+podojo usertests get checkout-usability-v1
+podojo usertests update checkout-usability-v1 -f changes.yaml
+podojo usertests delete checkout-usability-v1
+podojo usertests snippet                  # recorder script for self-hosted prototypes
+```
+
+### Synthetic participants
+
+The `synth` group drives a Playwright browser through a user test preview so an
+agent (e.g. Claude Code) can act as a synthetic participant:
+
+```bash
+podojo synth start checkout-usability-v1   # or a preview URL
+podojo synth state
+podojo synth click "Get Started"
+podojo synth fill "#answer" "It felt slow"
+podojo synth advance
+podojo synth stop
+```
+
+### Google Drive
+
+```bash
+podojo gdrive upload report.md --folder-id <id>
+podojo gdrive list --folder-id <id>
+```
+
+Requires a `credentials.json` service-account file in the current directory.
+
+## Links
+
+- [Source & issues](https://github.com/podojo/cli-podojo)
+- [Changelog](https://github.com/podojo/cli-podojo/blob/main/CHANGELOG.md)
+
+## License
+
+MIT

{podojo_cli-0.8.2 → podojo_cli-0.8.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "podojo-cli"
-version = "0.8.2"
+version = "0.8.3"
 description = "CLI for the Podojo user research platform"
 readme = "README.md"
 license = "MIT"

podojo_cli-0.8.2/PKG-INFO

@@ -1,47 +0,0 @@
-Metadata-Version: 2.4
-Name: podojo-cli
-Version: 0.8.2
-Summary: CLI for the Podojo user research platform
-Project-URL: Homepage, https://github.com/podojo/cli-podojo
-Project-URL: Source, https://github.com/podojo/cli-podojo
-Project-URL: Issues, https://github.com/podojo/cli-podojo/issues
-Project-URL: Changelog, https://github.com/podojo/cli-podojo/blob/main/CHANGELOG.md
-Author-email: Jochen Ade <jochen.ade@podojo.com>
-License-Expression: MIT
-Keywords: cli,podojo,transcripts,user-research,ux-research
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: End Users/Desktop
-Classifier: Intended Audience :: Other Audience
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Topic :: Utilities
-Requires-Python: >=3.12
-Requires-Dist: google-api-python-client>=2.0
-Requires-Dist: google-auth>=2.0
-Requires-Dist: httpx>=0.28
-Requires-Dist: keyring>=25.0
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: rich>=13.0
-Requires-Dist: typer>=0.15
-Provides-Extra: synth
-Requires-Dist: playwright>=1.40; extra == 'synth'
-Description-Content-Type: text/markdown
-
-# podojo-cli
-
-CLI for the Podojo user research platform.
-
-## Installation
-
-```bash
-uv tool install podojo-cli
-```
-
-## Usage
-
-```bash
-podojo --help
-```

podojo_cli-0.8.2/README.md

@@ -1,15 +0,0 @@
-# podojo-cli
-
-CLI for the Podojo user research platform.
-
-## Installation
-
-```bash
-uv tool install podojo-cli
-```
-
-## Usage
-
-```bash
-podojo --help
-```