podojo-cli 1.2.0__tar.gz → 1.4.0__tar.gz

{podojo_cli-1.2.0 → podojo_cli-1.4.0}/CHANGELOG.md

@@ -5,6 +5,16 @@ 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).
 
+## [1.4.0] - 2026-05-31
+
+### Added
+- Support `image_file:` in usertest step config — a local image path that is uploaded to Podojo-hosted storage on `create`/`update` and replaced with the hosted URL. Relative paths resolve against the YAML file's location. Externally-hosted `image:` URLs continue to work.
+
+## [1.3.0] - 2026-05-25
+
+### Removed
+- Drop `privacy_text` field from usertest config. It was never used in practice, and the participant frontend no longer renders it.
+
 ## [1.2.0] - 2026-05-25
 
 ### Removed

{podojo_cli-1.2.0 → podojo_cli-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: podojo-cli
-Version: 1.2.0
+Version: 1.4.0
 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-1.2.0 → podojo_cli-1.4.0}/pyproject.toml

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

{podojo_cli-1.2.0 → podojo_cli-1.4.0}/src/podojo_cli/client.py

@@ -132,6 +132,30 @@ class PodojoClient:
         r.raise_for_status()
         return r.json()
 
+    IMAGE_CONTENT_TYPES = {
+        ".png": "image/png",
+        ".jpg": "image/jpeg",
+        ".jpeg": "image/jpeg",
+        ".webp": "image/webp",
+        ".gif": "image/gif",
+    }
+
+    def upload_usertest_image(self, file_path: Path) -> dict:
+        content_type = self.IMAGE_CONTENT_TYPES.get(file_path.suffix.lower())
+        if content_type is None:
+            raise ValueError(
+                f"Unsupported image type '{file_path.suffix}'. Allowed: PNG, JPEG, WebP, GIF."
+            )
+        with file_path.open("rb") as f:
+            r = httpx.post(
+                f"{self.base_url}/usertests/images",
+                files={"file": (file_path.name, f, content_type)},
+                headers=self._headers(),
+                timeout=httpx.Timeout(None),
+            )
+        r.raise_for_status()
+        return r.json()
+
     def create_usertest(self, data: dict) -> dict:
         r = httpx.post(
             f"{self.base_url}/usertests",

{podojo_cli-1.2.0 → podojo_cli-1.4.0}/src/podojo_cli/commands/usertests.py

@@ -36,7 +36,7 @@ EXAMPLE_YAML = """\
 # Podojo Unmoderated User Test Configuration
 #
 # Required fields: usertest_id, title, logo, prototype_url, steps
-# Optional fields: welcome_text, privacy_text, promo_code, promo_code_info,
+# Optional fields: welcome_text, promo_code, promo_code_info,
 #                  project_name, live, collect_contact
 
 usertest_id: checkout-usability-v1
@@ -53,11 +53,6 @@ welcome_text: |
 
   This session takes about 10 minutes.
 
-# Optional: privacy notice
-privacy_text: |
-  Your responses are anonymous and will only be used to improve
-  our product. You can stop at any time.
-
 # Optional: reward for participants
 promo_code: THANKS10
 promo_code_info: "Use this code for 10% off your next purchase"
@@ -75,7 +70,10 @@ project_name: checkout-redesign-q1
 # Each step requires: type ("screen" or "prototype") and title
 # 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)
+# Optional per step: text (markdown), and either:
+#   image:      a URL to an externally-hosted image, or
+#   image_file: a path to a local image (uploaded to Podojo storage on create/update;
+#               relative paths resolve against this YAML file's location)
 steps:
   - type: screen
     variant: question
@@ -83,7 +81,7 @@ steps:
     text: |
       Look at this homepage screenshot.
       What stands out to you first?
-    image: https://example.com/screenshots/homepage.png
+    image_file: ./screenshots/homepage.png
 
   - type: screen
     variant: instruction
@@ -165,6 +163,35 @@ def _load_yaml(path: Path) -> dict:
     return data
 
 
+def _resolve_image_files(data: dict, base_dir: Path, client: PodojoClient) -> None:
+    """Upload any step `image_file` (local path) and replace it with the hosted URL."""
+    steps = data.get("steps")
+    if not isinstance(steps, list):
+        return
+    for i, step in enumerate(steps, 1):
+        if not isinstance(step, dict) or "image_file" not in step:
+            continue
+        raw_path = step.pop("image_file")
+        if not raw_path:
+            continue
+        image_path = Path(raw_path)
+        if not image_path.is_absolute():
+            image_path = (base_dir / image_path).resolve()
+        if not image_path.exists():
+            console.print(f"[red]Error:[/red] Step {i}: image file not found: {image_path}")
+            raise typer.Exit(1)
+        try:
+            result = client.upload_usertest_image(image_path)
+        except ValueError as ve:
+            console.print(f"[red]Error:[/red] Step {i}: {ve}")
+            raise typer.Exit(1)
+        except httpx.HTTPStatusError as he:
+            console.print(f"[red]Error:[/red] Step {i}: image upload failed: {_format_api_error(he)}")
+            raise typer.Exit(1)
+        step["image"] = result["url"]
+        console.print(f"[dim]Uploaded image for step {i}: {result['url']}[/dim]")
+
+
 def _format_api_error(e: httpx.HTTPStatusError) -> str:
     """Format API error into actionable message."""
     try:
@@ -262,6 +289,7 @@ def create_usertest(
         data["project_name"] = data["usertest_id"]
 
     client = PodojoClient()
+    _resolve_image_files(data, from_file.parent, client)
     try:
         result = client.create_usertest(data)
     except httpx.HTTPStatusError as e:
@@ -293,6 +321,7 @@ def update_usertest(
     data = _load_yaml(from_file)
 
     client = PodojoClient()
+    _resolve_image_files(data, from_file.parent, client)
     try:
         result = client.update_usertest(usertest_id, data)
     except httpx.HTTPStatusError as e:

{podojo_cli-1.2.0 → podojo_cli-1.4.0}/uv.lock

@@ -369,7 +369,7 @@ wheels = [
 
 [[package]]
 name = "podojo-cli"
-version = "1.2.0"
+version = "1.4.0"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },