wagapi 0.2.0__tar.gz → 0.2.2__tar.gz

{wagapi-0.2.0 → wagapi-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wagapi
-Version: 0.2.0
+Version: 0.2.2
 Summary: CLI client for the Wagtail Write API, optimised for LLM orchestration
 Project-URL: Repository, https://github.com/tomdyson/wagapi
 Project-URL: Issues, https://github.com/tomdyson/wagapi/issues
@@ -121,13 +121,13 @@ wagapi schema testapp.BlogPage
 
 ```bash
 wagapi pages list
-wagapi pages get 6
+wagapi pages get 3   # use an ID from the list above
 ```
 
 ### 5. Create a page
 
 ```bash
-wagapi pages create testapp.BlogPage --parent 5 \
+wagapi pages create testapp.BlogPage --parent /blog/ \
   --title "Iris Murdoch" \
   --body "## A Philosopher and Novelist
 
@@ -142,10 +142,10 @@ The `--body` flag accepts markdown, which is auto-converted to StreamField block
 
 ```bash
 # Publish a draft (use the page ID returned by create)
-wagapi pages publish 15
+wagapi pages publish <ID>
 
 # Update a page
-wagapi pages update 15 --title "Iris Murdoch: The Sovereignty of Good"
+wagapi pages update <ID> --title "Iris Murdoch: The Sovereignty of Good"
 
 # Create and publish in one step, using a URL path as parent
 wagapi pages create testapp.BlogPage --parent /blog/ \
@@ -155,20 +155,20 @@ wagapi pages create testapp.BlogPage --parent /blog/ \
   --publish
 
 # Unpublish
-wagapi pages unpublish 15
+wagapi pages unpublish <ID>
 
 # Delete (prompts for confirmation)
-wagapi pages delete 15
+wagapi pages delete <ID>
 ```
 
 ### 7. Inspect requests
 
 ```bash
 # See HTTP request/response details
-wagapi -v pages get 6
+wagapi -v pages get <ID>
 
 # Preview without executing
-wagapi --dry-run pages create testapp.SimplePage --parent 3 --title "Test"
+wagapi --dry-run pages create testapp.SimplePage --parent /home/ --title "Test"
 ```
 
 ### 8. Pipe-friendly JSON output
@@ -184,7 +184,7 @@ Force a format with `--json` or `--human`:
 
 ```bash
 wagapi --human pages list
-wagapi --json pages get 6
+wagapi --json pages get 42
 ```
 
 ## Configuration
@@ -305,14 +305,14 @@ She argued that moral progress comes from **attention**."
 **With extra fields:**
 
 ```bash
-wagapi pages create testapp.BlogPage --parent 5 \
+wagapi pages create testapp.BlogPage --parent /blog/ \
   --title "Iris Murdoch" --field published_date:2026-04-06
 ```
 
 **Raw mode for full StreamField control:**
 
 ```bash
-wagapi pages create testapp.BlogPage --parent 5 \
+wagapi pages create testapp.BlogPage --parent /blog/ \
   --title "Iris Murdoch" --raw \
   --field 'body:[{"type":"paragraph","value":"<p>Hello</p>","id":"abc123"}]'
 ```

{wagapi-0.2.0 → wagapi-0.2.2}/README.md

@@ -91,13 +91,13 @@ wagapi schema testapp.BlogPage
 
 ```bash
 wagapi pages list
-wagapi pages get 6
+wagapi pages get 3   # use an ID from the list above
 ```
 
 ### 5. Create a page
 
 ```bash
-wagapi pages create testapp.BlogPage --parent 5 \
+wagapi pages create testapp.BlogPage --parent /blog/ \
   --title "Iris Murdoch" \
   --body "## A Philosopher and Novelist
 
@@ -112,10 +112,10 @@ The `--body` flag accepts markdown, which is auto-converted to StreamField block
 
 ```bash
 # Publish a draft (use the page ID returned by create)
-wagapi pages publish 15
+wagapi pages publish <ID>
 
 # Update a page
-wagapi pages update 15 --title "Iris Murdoch: The Sovereignty of Good"
+wagapi pages update <ID> --title "Iris Murdoch: The Sovereignty of Good"
 
 # Create and publish in one step, using a URL path as parent
 wagapi pages create testapp.BlogPage --parent /blog/ \
@@ -125,20 +125,20 @@ wagapi pages create testapp.BlogPage --parent /blog/ \
   --publish
 
 # Unpublish
-wagapi pages unpublish 15
+wagapi pages unpublish <ID>
 
 # Delete (prompts for confirmation)
-wagapi pages delete 15
+wagapi pages delete <ID>
 ```
 
 ### 7. Inspect requests
 
 ```bash
 # See HTTP request/response details
-wagapi -v pages get 6
+wagapi -v pages get <ID>
 
 # Preview without executing
-wagapi --dry-run pages create testapp.SimplePage --parent 3 --title "Test"
+wagapi --dry-run pages create testapp.SimplePage --parent /home/ --title "Test"
 ```
 
 ### 8. Pipe-friendly JSON output
@@ -154,7 +154,7 @@ Force a format with `--json` or `--human`:
 
 ```bash
 wagapi --human pages list
-wagapi --json pages get 6
+wagapi --json pages get 42
 ```
 
 ## Configuration
@@ -275,14 +275,14 @@ She argued that moral progress comes from **attention**."
 **With extra fields:**
 
 ```bash
-wagapi pages create testapp.BlogPage --parent 5 \
+wagapi pages create testapp.BlogPage --parent /blog/ \
   --title "Iris Murdoch" --field published_date:2026-04-06
 ```
 
 **Raw mode for full StreamField control:**
 
 ```bash
-wagapi pages create testapp.BlogPage --parent 5 \
+wagapi pages create testapp.BlogPage --parent /blog/ \
   --title "Iris Murdoch" --raw \
   --field 'body:[{"type":"paragraph","value":"<p>Hello</p>","id":"abc123"}]'
 ```

{wagapi-0.2.0 → wagapi-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "wagapi"
-version = "0.2.0"
+version = "0.2.2"
 description = "CLI client for the Wagtail Write API, optimised for LLM orchestration"
 readme = "README.md"
 license = "MIT"

{wagapi-0.2.0 → wagapi-0.2.2}/tests/test_commands.py

@@ -97,6 +97,28 @@ def test_pages_list(runner):
     assert "Hello" in result.output
 
 
+@respx.mock
+def test_pages_list_with_parent(runner):
+    data = {
+        "meta": {"total_count": 1},
+        "items": [
+            {
+                "id": 42,
+                "title": "Hello",
+                "meta": {"type": "blog.BlogPage", "live": True},
+            }
+        ],
+    }
+    route = respx.get(f"{BASE_URL}/pages/").mock(
+        return_value=Response(200, json=data)
+    )
+    with mock.patch.dict("os.environ", ENV):
+        result = runner.invoke(cli, ["pages", "list", "--parent", "5"])
+    assert result.exit_code == 0
+    assert route.called
+    assert "parent" in str(route.calls[0].request.url)
+
+
 @respx.mock
 def test_pages_get(runner):
     data = {

wagapi-0.2.2/wagapi/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.2"

{wagapi-0.2.0 → wagapi-0.2.2}/wagapi/cli.py

@@ -35,7 +35,18 @@ def handle_api_errors(fn):
         except WagapiError as exc:
             click.echo(f"Error: {exc}", err=True)
             if hasattr(exc, "details") and exc.details:
-                click.echo(f"Details: {exc.details}", err=True)
+                details = exc.details
+                # Format field-level validation errors readably
+                if isinstance(details, dict) and "details" in details:
+                    for item in details["details"]:
+                        field = item.get("field", "")
+                        msg = item.get("message", str(item))
+                        if field:
+                            click.echo(f"  {field}: {msg}", err=True)
+                        else:
+                            click.echo(f"  {msg}", err=True)
+                else:
+                    click.echo(f"Details: {details}", err=True)
             sys.exit(exc.exit_code)
 
     return wrapper

{wagapi-0.2.0 → wagapi-0.2.2}/wagapi/commands/pages.py

@@ -91,7 +91,7 @@ def list_pages(
     if page_type:
         params["type"] = page_type
     if parent:
-        params["child_of"] = parent
+        params["parent"] = parent
     if descendant_of:
         params["descendant_of"] = descendant_of
     if status:
@@ -259,7 +259,7 @@ def delete(ctx: Context, page_id: int, yes: bool):
 
     ctx.client.delete_page(page_id)
     result = output(
-        page_id,
+        {"id": page_id, "deleted": True},
         format_page_deleted,
         force_json=ctx.force_json,
         force_human=ctx.force_human,

wagapi-0.2.2/wagapi/commands/schema.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+import click
+
+from wagapi.cli import Context, handle_api_errors, pass_ctx
+from wagapi.exceptions import UsageError
+from wagapi.formatting.output import (
+    format_json,
+    format_schema_detail,
+    format_schema_list,
+    output,
+)
+
+
+def _build_example_command(page_type: str, data: dict) -> str:
+    """Generate an example wagapi create command from schema data."""
+    create_schema = data.get("create_schema", {})
+    properties = create_schema.get("properties", {})
+    required = set(create_schema.get("required", []))
+    has_streamfield = bool(data.get("streamfield_blocks"))
+
+    # CLI handles type and parent itself; action is internal
+    skip = {"type", "parent", "action"}
+
+    parts = [f"wagapi pages create {page_type}", "--parent <ID_OR_PATH>"]
+
+    for field_name in properties:
+        if field_name in skip:
+            continue
+        if field_name not in required:
+            continue
+        prop = properties[field_name]
+
+        # StreamField body → use --body flag
+        if field_name == "body" and prop.get("type") == "array":
+            parts.append('--body "Your content here (markdown)"')
+            continue
+
+        # Derive a placeholder from the field type
+        ftype = prop.get("type", "")
+        if ftype == "string":
+            parts.append(f'--field {field_name}:"..."')
+        elif ftype == "integer":
+            parts.append(f"--field {field_name}:<ID>")
+        elif ftype == "array":
+            parts.append(f"--field {field_name}:[]")
+        else:
+            parts.append(f'--field {field_name}:"..."')
+
+    # title is always a CLI flag, not --field
+    parts = [p for p in parts if not p.startswith("--field title:")]
+    if "title" in required:
+        parts.insert(2, '--title "Your Title"')
+
+    return " \\\n  ".join(parts)
+
+
+@click.command()
+@click.argument("page_type", required=False, default=None)
+@pass_ctx
+@handle_api_errors
+def schema(ctx: Context, page_type: str | None) -> None:
+    """List page types, or show the schema for a specific type."""
+    if not ctx.client:
+        raise UsageError(
+            "Not configured. Run 'wagapi init' or set WAGAPI_URL and WAGAPI_TOKEN."
+        )
+
+    if page_type:
+        data = ctx.client.get_page_type_schema(page_type)
+        data["example_cli"] = _build_example_command(page_type, data)
+        result = output(
+            data,
+            format_schema_detail,
+            force_json=ctx.force_json,
+            force_human=ctx.force_human,
+        )
+    else:
+        data = ctx.client.list_page_types()
+        result = output(
+            data,
+            format_schema_list,
+            force_json=ctx.force_json,
+            force_human=ctx.force_human,
+        )
+
+    click.echo(result)

{wagapi-0.2.0 → wagapi-0.2.2}/wagapi/formatting/output.py

@@ -53,8 +53,8 @@ def format_page_updated(data: dict) -> str:
     return f'✓ Updated page {data["id"]} "{data.get("title", "")}" ({status})'
 
 
-def format_page_deleted(page_id: int) -> str:
-    return f"✓ Deleted page {page_id}"
+def format_page_deleted(data: dict) -> str:
+    return f'✓ Deleted page {data["id"]}'
 
 
 def format_page_published(data: dict) -> str:
@@ -75,6 +75,25 @@ def format_page_detail(data: dict) -> str:
     ]
     if meta.get("html_url"):
         lines.append(f'  URL: {meta["html_url"]}')
+    if meta.get("parent_id"):
+        lines.append(f'  Parent: {meta["parent_id"]}')
+
+    # Show custom fields (skip meta, id, title, slug which are already shown)
+    skip = {"id", "title", "slug", "meta", "alias_of"}
+    for key, value in data.items():
+        if key in skip or value is None:
+            continue
+        if isinstance(value, list) and value and isinstance(value[0], dict) and "type" in value[0]:
+            # StreamField — summarise block types
+            block_types = [b.get("type", "?") for b in value]
+            lines.append(f"  {key}: [{', '.join(block_types)}] ({len(value)} blocks)")
+        elif isinstance(value, list) and value:
+            lines.append(f"  {key}: {len(value)} items")
+        elif isinstance(value, list):
+            pass  # skip empty lists
+        else:
+            lines.append(f"  {key}: {value}")
+
     return "\n".join(lines)
 
 
@@ -170,6 +189,10 @@ def format_schema_detail(data: dict) -> str:
             block_names = [b.get("type", b.get("name", "?")) for b in blocks] if isinstance(blocks, list) else list(blocks.keys()) if isinstance(blocks, dict) else []
             lines.append(f"    {field_name}: {', '.join(block_names)}")
 
+    if data.get("example_cli"):
+        lines.append("")
+        lines.append(f"  Example:\n    {data['example_cli'].replace(chr(10), chr(10) + '    ')}")
+
     return "\n".join(lines)
 
 

wagapi-0.2.0/wagapi/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.0"

wagapi-0.2.0/wagapi/commands/schema.py

@@ -1,43 +0,0 @@
-from __future__ import annotations
-
-import click
-
-from wagapi.cli import Context, handle_api_errors, pass_ctx
-from wagapi.exceptions import UsageError
-from wagapi.formatting.output import (
-    format_json,
-    format_schema_detail,
-    format_schema_list,
-    output,
-)
-
-
-@click.command()
-@click.argument("page_type", required=False, default=None)
-@pass_ctx
-@handle_api_errors
-def schema(ctx: Context, page_type: str | None) -> None:
-    """List page types, or show the schema for a specific type."""
-    if not ctx.client:
-        raise UsageError(
-            "Not configured. Run 'wagapi init' or set WAGAPI_URL and WAGAPI_TOKEN."
-        )
-
-    if page_type:
-        data = ctx.client.get_page_type_schema(page_type)
-        result = output(
-            data,
-            format_schema_detail,
-            force_json=ctx.force_json,
-            force_human=ctx.force_human,
-        )
-    else:
-        data = ctx.client.list_page_types()
-        result = output(
-            data,
-            format_schema_list,
-            force_json=ctx.force_json,
-            force_human=ctx.force_human,
-        )
-
-    click.echo(result)