kitchenowl-cli 0.1.0__tar.gz

kitchenowl_cli-0.1.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: kitchenowl-cli
+Version: 0.1.0
+Summary: CLI for interacting with the KitchenOwl API.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: click>=8.1.7
+Requires-Dist: requests>=2.31.0
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: rich>=13.7.1
+Requires-Dist: pytest>=8.1.0
+
+# kitchenowl-cli
+
+Command-line client for KitchenOwl's `/api` endpoints, covering auth, household, recipe, shopping list, and user workflows.
+
+## Supported CLI surface
+
+- `kitchenowl auth [login|logout|status|signup]` — JWT login with refresh, logout and signup helpers.  
+- `kitchenowl config [show|set-default-household|server-settings]` — manage stored tokens/default household and inspect read-only server flags from `/api/health`.  
+- `kitchenowl household [list|use|get|create|update|delete]` and `kitchenowl household member [list|add|remove]`.  
+- `kitchenowl recipe [list|get|add|edit|delete]` with JSON/YAML payload support and flag-based editors.  
+- `kitchenowl shoppinglist [list|create|delete|items|add-item|add-item-by-name|suggested|remove-item]` plus the dedicated `remove-item` command to mark items done.  
+- `kitchenowl user [list|get|search|create|update|delete]` for admins.
+- `run_cli_e2e.sh` script exercises login, household creation, lists, recipes, planner, expenses, and optionally house cleanup.
+
+## Quick install
+
+```bash
+cd kitchenowl-cli
+python3 -m pip install -e .
+```
+
+## Quick start examples
+
+```bash
+kitchenowl auth login --server https://your-kitchenowl.example.com
+# tip: both https://host and https://host/api are accepted
+kitchenowl config server-settings
+kitchenowl household list
+kitchenowl household member list --household-id 42
+kitchenowl household member add 17 --household-id 42 --admin
+kitchenowl shoppinglist create "Weekly List" --household-id 42
+kitchenowl shoppinglist add-item-by-name 12 Milk --description "2L"
+kitchenowl shoppinglist remove-item 12 456 -y
+kitchenowl recipe add --name "Tomato Soup" --description "Simple soup" --household-id 42 --yields 2 --time 25
+kitchenowl recipe edit 123 --description "Updated"
+kitchenowl recipe delete 123
+kitchenowl user list
+kitchenowl auth signup --username newuser --name "New User"
+```
+
+`auth login` / `auth signup` will always ask for the server URL when `--server` is not provided, using your last saved server as the default.
+
+## Read-only server settings
+
+Inspect the public read-only settings exposed by the server health endpoint (works without login if you pass `--server`):
+
+```bash
+kitchenowl config server-settings --server https://your-kitchenowl.example.com
+kitchenowl config server-settings --json
+```
+
+This currently shows:
+- `open_registration`
+- `email_mandatory`
+- `oidc_provider`
+- `privacy_policy` (if configured)
+- `terms` (if configured)
+
+## File-based recipe editing
+
+```bash
+kitchenowl recipe add --household-id 1 --from-file recipe.yml
+kitchenowl recipe edit 42 --from-file recipe.yml
+```
+
+Example `recipe.yml`:
+
+```yaml
+name: Tomato Soup
+description: Simple soup
+time: 25
+cook_time: 20
+prep_time: 5
+yields: 2
+visibility: 0
+source: ""
+items:
+  - name: Tomatoes
+    description: 6 pcs
+    optional: false
+  - name: Salt
+    description: 1 tsp
+    optional: false
+tags:
+  - soup
+  - vegetarian
+```
+
+## What’s not implemented yet
+
+- Planner CLI commands (beyond the end-to-end script that calls `/planner/recipe`).  
+- Expense management (create/edit/delete categories or entries) via CLI wrappers.  
+- Shopping list item bulk operations (remove multiple items at once) and the planner suggestion refresh endpoints.  
+- More advanced user workflows (password resets, token management, server admin tooling) are still API-only.

kitchenowl_cli-0.1.0/README.md

@@ -0,0 +1,94 @@
+# kitchenowl-cli
+
+Command-line client for KitchenOwl's `/api` endpoints, covering auth, household, recipe, shopping list, and user workflows.
+
+## Supported CLI surface
+
+- `kitchenowl auth [login|logout|status|signup]` — JWT login with refresh, logout and signup helpers.  
+- `kitchenowl config [show|set-default-household|server-settings]` — manage stored tokens/default household and inspect read-only server flags from `/api/health`.  
+- `kitchenowl household [list|use|get|create|update|delete]` and `kitchenowl household member [list|add|remove]`.  
+- `kitchenowl recipe [list|get|add|edit|delete]` with JSON/YAML payload support and flag-based editors.  
+- `kitchenowl shoppinglist [list|create|delete|items|add-item|add-item-by-name|suggested|remove-item]` plus the dedicated `remove-item` command to mark items done.  
+- `kitchenowl user [list|get|search|create|update|delete]` for admins.
+- `run_cli_e2e.sh` script exercises login, household creation, lists, recipes, planner, expenses, and optionally house cleanup.
+
+## Quick install
+
+```bash
+cd kitchenowl-cli
+python3 -m pip install -e .
+```
+
+## Quick start examples
+
+```bash
+kitchenowl auth login --server https://your-kitchenowl.example.com
+# tip: both https://host and https://host/api are accepted
+kitchenowl config server-settings
+kitchenowl household list
+kitchenowl household member list --household-id 42
+kitchenowl household member add 17 --household-id 42 --admin
+kitchenowl shoppinglist create "Weekly List" --household-id 42
+kitchenowl shoppinglist add-item-by-name 12 Milk --description "2L"
+kitchenowl shoppinglist remove-item 12 456 -y
+kitchenowl recipe add --name "Tomato Soup" --description "Simple soup" --household-id 42 --yields 2 --time 25
+kitchenowl recipe edit 123 --description "Updated"
+kitchenowl recipe delete 123
+kitchenowl user list
+kitchenowl auth signup --username newuser --name "New User"
+```
+
+`auth login` / `auth signup` will always ask for the server URL when `--server` is not provided, using your last saved server as the default.
+
+## Read-only server settings
+
+Inspect the public read-only settings exposed by the server health endpoint (works without login if you pass `--server`):
+
+```bash
+kitchenowl config server-settings --server https://your-kitchenowl.example.com
+kitchenowl config server-settings --json
+```
+
+This currently shows:
+- `open_registration`
+- `email_mandatory`
+- `oidc_provider`
+- `privacy_policy` (if configured)
+- `terms` (if configured)
+
+## File-based recipe editing
+
+```bash
+kitchenowl recipe add --household-id 1 --from-file recipe.yml
+kitchenowl recipe edit 42 --from-file recipe.yml
+```
+
+Example `recipe.yml`:
+
+```yaml
+name: Tomato Soup
+description: Simple soup
+time: 25
+cook_time: 20
+prep_time: 5
+yields: 2
+visibility: 0
+source: ""
+items:
+  - name: Tomatoes
+    description: 6 pcs
+    optional: false
+  - name: Salt
+    description: 1 tsp
+    optional: false
+tags:
+  - soup
+  - vegetarian
+```
+
+## What’s not implemented yet
+
+- Planner CLI commands (beyond the end-to-end script that calls `/planner/recipe`).  
+- Expense management (create/edit/delete categories or entries) via CLI wrappers.  
+- Shopping list item bulk operations (remove multiple items at once) and the planner suggestion refresh endpoints.  
+- More advanced user workflows (password resets, token management, server admin tooling) are still API-only.

kitchenowl_cli-0.1.0/kitchenowl_cli/__init__.py

@@ -0,0 +1,2 @@
+__all__ = ["__version__"]
+__version__ = "0.1.0"

kitchenowl_cli-0.1.0/kitchenowl_cli/api.py

@@ -0,0 +1,194 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+import requests
+
+from .config import save_config
+
+
+def normalize_server_url(url: str) -> str:
+    normalized = url.rstrip("/")
+    # Accept both base URLs (https://host) and API URLs (https://host/api)
+    # from user input/config without producing /api/api/* requests.
+    if normalized.endswith("/api"):
+        normalized = normalized[:-4]
+    return normalized
+
+
+def _extract_error(response: requests.Response) -> str:
+    try:
+        payload = response.json()
+    except ValueError:
+        return response.text.strip() or f"HTTP {response.status_code}"
+
+    if isinstance(payload, dict):
+        for key in ("msg", "message", "error", "detail"):
+            if key in payload and payload[key]:
+                return str(payload[key])
+    return str(payload)
+
+
+@dataclass
+class ApiError(Exception):
+    message: str
+    status_code: int | None = None
+
+    def __str__(self) -> str:
+        if self.status_code is None:
+            return self.message
+        return f"{self.message} (HTTP {self.status_code})"
+
+
+class ApiClient:
+    def __init__(self, config: dict[str, Any]):
+        server_url = config.get("server_url")
+        if not server_url:
+            raise ApiError("No server configured. Run `kitchenowl auth login` first.")
+        self.config = config
+        self.server_url = normalize_server_url(server_url)
+        self.session = requests.Session()
+
+    def _url(self, path: str) -> str:
+        if path.startswith("http://") or path.startswith("https://"):
+            return path
+        if not path.startswith("/"):
+            path = f"/{path}"
+        return f"{self.server_url}{path}"
+
+    def _auth_header(self, token_key: str) -> dict[str, str]:
+        token = self.config.get(token_key)
+        if not token:
+            raise ApiError("Not authenticated. Run `kitchenowl auth login`.")
+        return {"Authorization": f"Bearer {token}"}
+
+    def refresh_tokens(self) -> None:
+        headers = self._auth_header("refresh_token")
+        response = self.session.get(
+            self._url("/api/auth/refresh"),
+            headers=headers,
+            timeout=30,
+        )
+        if not response.ok:
+            raise ApiError(
+                f"Token refresh failed: {_extract_error(response)}",
+                response.status_code,
+            )
+        payload = response.json()
+        self.config["access_token"] = payload["access_token"]
+        self.config["refresh_token"] = payload["refresh_token"]
+        if "user" in payload:
+            self.config["user"] = payload["user"]
+        save_config(self.config)
+
+    def request(
+        self,
+        method: str,
+        path: str,
+        *,
+        json: dict[str, Any] | None = None,
+        params: dict[str, Any] | None = None,
+        auth: str = "access",
+        _retry: bool = True,
+    ) -> Any:
+        headers: dict[str, str] = {}
+        if auth == "access":
+            headers.update(self._auth_header("access_token"))
+        elif auth == "refresh":
+            headers.update(self._auth_header("refresh_token"))
+
+        response = self.session.request(
+            method=method.upper(),
+            url=self._url(path),
+            json=json,
+            params=params,
+            headers=headers,
+            timeout=30,
+        )
+
+        if response.status_code == 401 and auth == "access" and _retry:
+            self.refresh_tokens()
+            return self.request(
+                method,
+                path,
+                json=json,
+                params=params,
+                auth=auth,
+                _retry=False,
+            )
+
+        if not response.ok:
+            raise ApiError(_extract_error(response), response.status_code)
+
+        if response.text.strip():
+            try:
+                return response.json()
+            except ValueError:
+                return response.text
+        return None
+
+    def get(self, path: str, *, params: dict[str, Any] | None = None) -> Any:
+        return self.request("GET", path, params=params)
+
+    def get_public(self, path: str, *, params: dict[str, Any] | None = None) -> Any:
+        return self.request("GET", path, params=params, auth="none")
+
+    def post(self, path: str, *, json: dict[str, Any] | None = None) -> Any:
+        return self.request("POST", path, json=json)
+
+    def delete(self, path: str, *, json: dict[str, Any] | None = None) -> Any:
+        return self.request("DELETE", path, json=json)
+
+    def put(self, path: str, *, json: dict[str, Any] | None = None) -> Any:
+        return self.request("PUT", path, json=json)
+
+
+def login(
+    server_url: str,
+    username: str,
+    password: str,
+    *,
+    device: str = "kitchenowl-cli",
+) -> dict[str, Any]:
+    url = f"{normalize_server_url(server_url)}/api/auth"
+    response = requests.post(
+        url,
+        json={
+            "username": username,
+            "password": password,
+            "device": device,
+        },
+        timeout=30,
+    )
+    if not response.ok:
+        raise ApiError(_extract_error(response), response.status_code)
+    return response.json()
+
+
+def signup(
+    server_url: str,
+    username: str,
+    password: str,
+    name: str,
+    *,
+    email: str | None = None,
+    device: str = "kitchenowl-cli",
+) -> dict[str, Any]:
+    url = f"{normalize_server_url(server_url)}/api/auth/signup"
+    body: dict[str, Any] = {
+        "username": username,
+        "password": password,
+        "name": name,
+        "device": device,
+    }
+    if email:
+        body["email"] = email
+    response = requests.post(
+        url,
+        json=body,
+        timeout=30,
+    )
+    if not response.ok:
+        raise ApiError(_extract_error(response), response.status_code)
+    return response.json()

kitchenowl_cli-0.1.0/kitchenowl_cli/commands/__init__.py

@@ -0,0 +1 @@
+# Command package marker.

kitchenowl_cli-0.1.0/kitchenowl_cli/commands/auth.py

@@ -0,0 +1,162 @@
+from __future__ import annotations
+
+import click
+from rich.console import Console
+from rich.table import Table
+
+from kitchenowl_cli.api import ApiClient, ApiError, login as api_login, normalize_server_url, signup as api_signup
+from kitchenowl_cli.config import clear_auth_tokens, load_config, save_config
+
+
+console = Console()
+
+
+@click.group()
+def auth() -> None:
+    """Authentication commands."""
+
+
+@auth.command()
+@click.option("--server", help="KitchenOwl server URL (e.g. https://kitchenowl.example.com).")
+@click.option("--username", help="Username or email.")
+@click.option("--password", help="Password.")
+@click.option("--device", default="kitchenowl-cli", show_default=True, help="Device label for token tracking.")
+def login(server: str | None, username: str | None, password: str | None, device: str) -> None:
+    """Login and store access + refresh tokens."""
+    cfg = load_config()
+    if server is not None:
+        server_url = server
+    else:
+        default_server = cfg.get("server_url", "")
+        server_url = click.prompt(
+            "Server URL",
+            default=default_server,
+            show_default=bool(default_server),
+        )
+    if not username:
+        username = click.prompt("Username or email")
+    if not password:
+        password = click.prompt("Password", hide_input=True)
+
+    try:
+        payload = api_login(server_url, username, password, device=device)
+    except ApiError as exc:
+        raise click.ClickException(str(exc)) from exc
+
+    cfg["server_url"] = normalize_server_url(server_url)
+    cfg["access_token"] = payload["access_token"]
+    cfg["refresh_token"] = payload["refresh_token"]
+    cfg["user"] = payload.get("user")
+    save_config(cfg)
+
+    try:
+        client = ApiClient(cfg)
+        households = client.get("/api/household")
+        if households and isinstance(households, list) and not cfg.get("default_household"):
+            cfg["default_household"] = households[0]["id"]
+            save_config(cfg)
+    except ApiError:
+        pass
+
+    console.print("[green]Login successful.[/green]")
+    if cfg.get("default_household"):
+        console.print(f"Default household: {cfg['default_household']}")
+
+
+@auth.command()
+@click.option("--server", help="KitchenOwl server URL (e.g. https://kitchenowl.example.com).")
+@click.option("--username", help="New username.")
+@click.option("--name", help="Full name.")
+@click.option("--password", help="Password.")
+@click.option("--email", help="Optional email.")
+@click.option("--device", default="kitchenowl-cli", show_default=True, help="Device label for token tracking.")
+def signup(
+    server: str | None,
+    username: str | None,
+    name: str | None,
+    password: str | None,
+    email: str | None,
+    device: str,
+) -> None:
+    """Register a new user and store its tokens."""
+    cfg = load_config()
+    if server is not None:
+        server_url = server
+    else:
+        default_server = cfg.get("server_url", "")
+        server_url = click.prompt(
+            "Server URL",
+            default=default_server,
+            show_default=bool(default_server),
+        )
+    if not username:
+        username = click.prompt("Username or email")
+    if not name:
+        name = click.prompt("Full name")
+    if not password:
+        password = click.prompt("Password", hide_input=True)
+
+    try:
+        payload = api_signup(
+            server_url,
+            username,
+            password,
+            name,
+            email=email,
+            device=device,
+        )
+    except ApiError as exc:
+        raise click.ClickException(str(exc)) from exc
+
+    cfg["server_url"] = normalize_server_url(server_url)
+    cfg["access_token"] = payload["access_token"]
+    cfg["refresh_token"] = payload["refresh_token"]
+    cfg["user"] = payload.get("user")
+    save_config(cfg)
+
+    try:
+        client = ApiClient(cfg)
+        households = client.get("/api/household")
+        if households and isinstance(households, list) and not cfg.get("default_household"):
+            cfg["default_household"] = households[0]["id"]
+            save_config(cfg)
+    except ApiError:
+        pass
+
+    console.print("[green]Signup successful.[/green]")
+    if cfg.get("default_household"):
+        console.print(f"Default household: {cfg['default_household']}")
+
+
+@auth.command()
+def status() -> None:
+    """Show current auth status."""
+    cfg = load_config()
+    if not cfg.get("server_url"):
+        console.print("No server configured.")
+        return
+
+    table = Table(show_header=False, box=None)
+    table.add_row("Server", str(cfg["server_url"]))
+    table.add_row("Default household", str(cfg.get("default_household", "-")))
+
+    if not cfg.get("access_token"):
+        table.add_row("Logged in", "No")
+        console.print(table)
+        return
+
+    try:
+        client = ApiClient(cfg)
+        user = client.get("/api/user")
+        table.add_row("Logged in", "Yes")
+        table.add_row("User", f"{user.get('name', '-')} (id={user.get('id', '-')})")
+    except ApiError as exc:
+        table.add_row("Logged in", f"No ({exc})")
+    console.print(table)
+
+
+@auth.command()
+def logout() -> None:
+    """Clear stored auth tokens."""
+    clear_auth_tokens()
+    console.print("[green]Logged out.[/green]")

kitchenowl_cli-0.1.0/kitchenowl_cli/commands/config_cmd.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+
+import json
+
+import click
+from rich.console import Console
+from rich.table import Table
+
+from kitchenowl_cli.api import ApiClient, ApiError, normalize_server_url
+from kitchenowl_cli.config import load_config, save_config
+
+
+console = Console()
+
+
+@click.group("config")
+def config_group() -> None:
+    """Configuration commands."""
+
+
+@config_group.command("show")
+@click.option("--json", "as_json", is_flag=True, help="Output as JSON.")
+def show_config(as_json: bool) -> None:
+    """Show saved CLI configuration."""
+    cfg = load_config()
+    safe = dict(cfg)
+    for key in ("access_token", "refresh_token"):
+        if safe.get(key):
+            safe[key] = f"{str(safe[key])[:12]}..."
+
+    if as_json:
+        click.echo(json.dumps(safe, indent=2, sort_keys=True))
+        return
+
+    if not safe:
+        console.print("No config found.")
+        return
+    for key, value in safe.items():
+        console.print(f"{key}: {value}")
+
+
+@config_group.command("set-default-household")
+@click.argument("household_id", type=int)
+def set_default_household(household_id: int) -> None:
+    """Set default household ID for recipe commands."""
+    cfg = load_config()
+    cfg["default_household"] = household_id
+    save_config(cfg)
+    console.print(f"[green]Default household set to {household_id}.[/green]")
+
+
+@config_group.command("server-settings")
+@click.option("--server", help="KitchenOwl server URL (overrides saved config).")
+@click.option("--json", "as_json", is_flag=True, help="Output as JSON.")
+def server_settings(server: str | None, as_json: bool) -> None:
+    """Show read-only server settings exposed by /api/health."""
+    cfg = load_config()
+    server_url = server or cfg.get("server_url")
+    if not server_url:
+        raise click.ClickException("No server configured. Provide --server or login first.")
+
+    client = ApiClient({"server_url": normalize_server_url(server_url)})
+    health = None
+    last_error: ApiError | None = None
+    for path in (
+        "/api/health",
+        "/api/health/8M4F88S8ooi4sMbLBfkkV7ctWwgibW6V",
+    ):
+        try:
+            health = client.get_public(path)
+            break
+        except ApiError as exc:
+            last_error = exc
+            continue
+
+    if health is None:
+        raise click.ClickException(str(last_error) if last_error else "Could not read server settings.")
+
+    settings = {
+        "open_registration": bool(health.get("open_registration", False)),
+        "email_mandatory": bool(health.get("email_mandatory", False)),
+        "oidc_provider": health.get("oidc_provider", []),
+    }
+    for key in ("privacy_policy", "terms"):
+        if key in health:
+            settings[key] = health[key]
+
+    if as_json:
+        click.echo(json.dumps(settings, indent=2, sort_keys=True))
+        return
+
+    table = Table(show_header=False, box=None)
+    table.add_row("server", normalize_server_url(server_url))
+    for key, value in settings.items():
+        rendered = ", ".join(value) if isinstance(value, list) else str(value)
+        table.add_row(key, rendered)
+    console.print(table)