podojo-cli 0.4.2__tar.gz → 0.4.4__tar.gz

{podojo_cli-0.4.2 → podojo_cli-0.4.4}/.github/workflows/publish.yml

@@ -14,10 +14,12 @@ jobs:
       id-token: write
       attestations: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
-      - uses: astral-sh/setup-uv@v4
+      - uses: astral-sh/setup-uv@v8.0.0
 
       - run: uv build
 
       - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true

{podojo_cli-0.4.2 → podojo_cli-0.4.4}/CHANGELOG.md

@@ -5,6 +5,17 @@ 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.4.4] - 2026-04-19
+
+### Added
+- `usertests snippet` command prints the recorder script to embed in self-hosted prototypes
+- `usertests create` now hints at the snippet command so users know how to enable screen recording
+
+## [0.4.3] - 2026-04-14
+
+### Added
+- Support `instruction` step variant for usertests (briefing screen with a "Continue" button, useful before prototype steps)
+
 ## [0.4.2] - 2026-04-05
 
 ### Changed

{podojo_cli-0.4.2 → podojo_cli-0.4.4}/CLAUDE.md

@@ -39,7 +39,7 @@ podojo usertests validate usertest.yaml # validate without creating
 
 User test configs are YAML files. Run `podojo usertests example` for the full template.
 Required fields: `usertest_id`, `client`, `title`, `logo`, `prototype_url`, `steps`.
-Each step needs `type` ("screen" or "prototype") and `title`. Screen steps should have `variant` ("question" or "task").
+Each step needs `type` ("screen" or "prototype") and `title`. Screen steps should have `variant` ("question", "task", or "instruction" — instruction screens render a "Continue" button instead of "Done with Step", useful as a briefing before a prototype step).
 
 ## Configuration
 

{podojo_cli-0.4.2 → podojo_cli-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: podojo-cli
-Version: 0.4.2
+Version: 0.4.4
 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

{podojo_cli-0.4.2 → podojo_cli-0.4.4}/pyproject.toml

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

{podojo_cli-0.4.2 → podojo_cli-0.4.4}/src/podojo_cli/commands/usertests.py

@@ -13,9 +13,25 @@ console = Console()
 
 REQUIRED_FIELDS = ["usertest_id", "title", "logo", "prototype_url", "steps"]
 VALID_STEP_TYPES = {"screen", "prototype"}
-VALID_STEP_VARIANTS = {"question", "task", "intro", "feedback"}
+VALID_STEP_VARIANTS = {"question", "task", "intro", "feedback", "instruction"}
 REQUIRED_STEP_FIELDS = ["type", "title"]
 
+RECORDER_SNIPPET = """\
+<script src="https://usertests.podojo.com/player.js"></script>
+<script>
+  if (typeof rrweb === "undefined") {
+    console.error("[rrweb] failed to load — screen recording disabled");
+  } else {
+    rrweb.record({
+      emit(event) {
+        window.parent.postMessage({ type: "rrweb-event", event: event }, "*");
+      },
+      checkoutEveryNms: 30000,
+    });
+  }
+</script>
+"""
+
 EXAMPLE_YAML = """\
 # Podojo Unmoderated User Test Configuration
 #
@@ -53,7 +69,8 @@ project_name: checkout-redesign-q1
 
 # Steps define what participants see and do
 # Each step requires: type ("screen" or "prototype") and title
-# Screen steps should have a variant: "question" (open-ended) or "task" (action-based)
+# Screen steps should have a variant: "question" (open-ended), "task" (action-based),
+# or "instruction" (briefing screen shown before a prototype step — uses a "Continue" button)
 # Optional per step: text (markdown), image (URL)
 steps:
   - type: screen
@@ -64,6 +81,13 @@ steps:
       What stands out to you first?
     image: https://example.com/screenshots/homepage.png
 
+  - type: screen
+    variant: instruction
+    title: Next, you'll try the prototype
+    text: |
+      On the next screen you'll see a working prototype.
+      Try to buy a pair of running shoes, and think aloud as you go.
+
   - type: prototype
     title: Complete a Purchase
     text: |
@@ -115,7 +139,7 @@ def validate_usertest_data(data: dict) -> list[str]:
                 variant = step.get("variant")
                 if step_type == "screen" and variant is not None and variant not in VALID_STEP_VARIANTS:
                     errors.append(
-                        f"Step {i}: 'variant' must be 'question' or 'task', got '{variant}'"
+                        f"Step {i}: 'variant' must be one of {sorted(VALID_STEP_VARIANTS)}, got '{variant}'"
                     )
     return errors
 
@@ -249,6 +273,11 @@ def create_usertest(
     if group:
         console.print(f"  Preview: https://usertests.podojo.com/preview/{group}/{usertest_id}")
         console.print(f"  Live:    https://usertests.podojo.com/{group}?test={usertest_id}")
+    console.print(
+        "\n[dim]If your prototype is self-hosted, add the recorder script to its "
+        "[bold]<head>[/bold] to enable screen recording.\n"
+        "Run [bold]podojo usertests snippet[/bold] to print it.[/dim]"
+    )
 
 
 @app.command("update")
@@ -315,3 +344,9 @@ def validate(
 def example():
     """Print an example user test YAML template."""
     print(EXAMPLE_YAML)
+
+
+@app.command("snippet")
+def snippet():
+    """Print the recorder script to embed in self-hosted prototypes."""
+    print(RECORDER_SNIPPET)

{podojo_cli-0.4.2 → podojo_cli-0.4.4}/tests/test_usertests.py

@@ -126,6 +126,7 @@ def test_create_usertest(runner, httpx_mock, tmp_path):
     assert "test-usertest-1" in result.output
     assert "https://usertests.podojo.com/preview/test-group/test-usertest-1" in result.output
     assert "https://usertests.podojo.com/test-group?test=test-usertest-1" in result.output
+    assert "podojo usertests snippet" in result.output
 
 
 def test_create_usertest_file_not_found(runner):
@@ -280,3 +281,11 @@ def test_example(runner):
     assert "steps:" in result.output
     assert "prototype" in result.output
     assert "screen" in result.output
+
+
+def test_snippet(runner):
+    result = runner.invoke(app, ["usertests", "snippet"])
+
+    assert result.exit_code == 0
+    assert "player.js" in result.output
+    assert "rrweb.record" in result.output

{podojo_cli-0.4.2 → podojo_cli-0.4.4}/uv.lock

@@ -472,7 +472,7 @@ wheels = [
 
 [[package]]
 name = "podojo-cli"
-version = "0.3.2"
+version = "0.4.4"
 source = { editable = "." }
 dependencies = [
     { name = "google-api-python-client" },