wealthbox-cli 1.0.0__tar.gz → 1.0.2__tar.gz

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/CONTRIBUTING.md

@@ -15,7 +15,13 @@ source .venv/bin/activate  # macOS/Linux
 pip install -e ".[dev]"
 ```
 
-Copy `.env.example` to `.env` and add your Wealthbox API token.
+Configure your Wealthbox API token:
+
+```bash
+wbox config set-token
+```
+
+Or copy `.env.example` to `.env` and add your token there.
 
 ## Running Tests
 
@@ -32,8 +38,8 @@ ruff check src/
 mypy src/
 ```
 
-- **ruff** for linting (E, F, I rules; 100-char line length)
-- **mypy** in strict mode
+- **ruff** for linting (E, F, I rules; 120-char line length)
+- **mypy** in strict mode (has known `untyped-decorator` warnings from Typer — not currently enforced in CI)
 
 ## Project Architecture
 
@@ -55,11 +61,20 @@ Three layers under `src/wealthbox_tools/`:
 6. If the resource has category types, add them via `make_category_command()` in the resource's `categories` sub-app
 7. Add tests in `tests/test_<resource>_create.py` and `tests/test_<resource>_update.py`
 
+## CI
+
+Pull requests and pushes to `main` run GitHub Actions CI:
+
+- **Lint:** `ruff check src/ tests/`
+- **Test:** `pytest` across Python 3.11, 3.12, 3.13
+
+Both must pass before merging.
+
 ## Pull Requests
 
 - Keep PRs focused — one feature or fix per PR
 - All tests must pass (`pytest`)
-- No ruff or mypy errors
+- No ruff errors
 - Update the CLI reference docs if commands change
 
 ## Reporting Issues

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wealthbox-cli
-Version: 1.0.0
+Version: 1.0.2
 Summary: CLI and client library for the Wealthbox CRM API
 Project-URL: Homepage, https://github.com/massive-value/wealthbox-cli
 Project-URL: Issues, https://github.com/massive-value/wealthbox-cli/issues
@@ -76,6 +76,18 @@ Official API documentation: https://dev.wealthbox.com
 pip install wealthbox-cli
 ```
 
+### With pipx (recommended for Ubuntu/Debian)
+
+On systems where the system Python is externally managed (Ubuntu 23.04+, Debian 12+),
+`pip install` outside a virtual environment is blocked by [PEP 668](https://peps.python.org/pep-0668/).
+Use [pipx](https://pipx.pypa.io/) to install CLI tools in isolated environments:
+
+``` bash
+pipx install wealthbox-cli
+```
+
+This puts `wbox` and `wb` on your PATH without touching system Python.
+
 ### From source (development)
 
 ``` bash
@@ -92,26 +104,44 @@ pip install -e ".[dev]"
 
 ## Configuration
 
-Copy `.env.example` to `.env` and fill in your token:
+### Getting your API token
 
-```
-WEALTHBOX_TOKEN=your_api_token_here
+1. Log in to [Wealthbox](https://app.crmworkspace.com)
+2. Click the three dots menu (**...**) in the top right
+3. Go to **Settings** -> **API Access**
+4. Click **Create Access Token**
+
+### Storing your token
+
+``` bash
+wbox config set-token
 ```
 
-Or set it as an environment variable:
+This prompts for your Wealthbox API token (input is masked) and stores it in
+`~/.config/wbox/config.json` (Linux/macOS) or `%APPDATA%\wbox\config.json` (Windows).
 
-**macOS/Linux**
+Other configuration commands:
 
 ``` bash
-export WEALTHBOX_TOKEN="your_api_token_here"
+wbox config show     # display stored config (token masked)
+wbox config clear    # remove stored config
 ```
 
-**Windows (PowerShell)**
+**Alternative methods** (for CI, scripting, or containers):
+
+``` bash
+# Environment variable
+export WEALTHBOX_TOKEN="your_api_token_here"
 
-``` powershell
-setx WEALTHBOX_TOKEN "your_api_token_here"
+# .env file in working directory
+echo 'WEALTHBOX_TOKEN=your_api_token_here' > .env
+
+# Per-command flag
+wbox contacts list --token your_api_token_here
 ```
 
+Token is resolved in this order: `--token` flag > `WEALTHBOX_TOKEN` env var > config file > `.env` file.
+
 ------------------------------------------------------------------------
 
 ## Usage

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/README.md

@@ -45,6 +45,18 @@ Official API documentation: https://dev.wealthbox.com
 pip install wealthbox-cli
 ```
 
+### With pipx (recommended for Ubuntu/Debian)
+
+On systems where the system Python is externally managed (Ubuntu 23.04+, Debian 12+),
+`pip install` outside a virtual environment is blocked by [PEP 668](https://peps.python.org/pep-0668/).
+Use [pipx](https://pipx.pypa.io/) to install CLI tools in isolated environments:
+
+``` bash
+pipx install wealthbox-cli
+```
+
+This puts `wbox` and `wb` on your PATH without touching system Python.
+
 ### From source (development)
 
 ``` bash
@@ -61,26 +73,44 @@ pip install -e ".[dev]"
 
 ## Configuration
 
-Copy `.env.example` to `.env` and fill in your token:
+### Getting your API token
 
-```
-WEALTHBOX_TOKEN=your_api_token_here
+1. Log in to [Wealthbox](https://app.crmworkspace.com)
+2. Click the three dots menu (**...**) in the top right
+3. Go to **Settings** -> **API Access**
+4. Click **Create Access Token**
+
+### Storing your token
+
+``` bash
+wbox config set-token
 ```
 
-Or set it as an environment variable:
+This prompts for your Wealthbox API token (input is masked) and stores it in
+`~/.config/wbox/config.json` (Linux/macOS) or `%APPDATA%\wbox\config.json` (Windows).
 
-**macOS/Linux**
+Other configuration commands:
 
 ``` bash
-export WEALTHBOX_TOKEN="your_api_token_here"
+wbox config show     # display stored config (token masked)
+wbox config clear    # remove stored config
 ```
 
-**Windows (PowerShell)**
+**Alternative methods** (for CI, scripting, or containers):
+
+``` bash
+# Environment variable
+export WEALTHBOX_TOKEN="your_api_token_here"
 
-``` powershell
-setx WEALTHBOX_TOKEN "your_api_token_here"
+# .env file in working directory
+echo 'WEALTHBOX_TOKEN=your_api_token_here' > .env
+
+# Per-command flag
+wbox contacts list --token your_api_token_here
 ```
 
+Token is resolved in this order: `--token` flag > `WEALTHBOX_TOKEN` env var > config file > `.env` file.
+
 ------------------------------------------------------------------------
 
 ## Usage

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "wealthbox-cli"
-version = "1.0.0"
+version = "1.0.2"
 description = "CLI and client library for the Wealthbox CRM API"
 readme = "README.md"
 requires-python = ">=3.11"

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/_util.py

@@ -11,11 +11,42 @@ from typing import Any
 
 import typer
 from pydantic import ValidationError
+from typer.core import TyperGroup
 
 from wealthbox_tools.client import WealthboxAPIError, WealthboxClient
 from wealthbox_tools.models import CategoryListQuery, CategoryType, LinkedToRef, TaskResourceType
 
 
+class _GetShortcutGroup(TyperGroup):
+    """Typer Group that routes numeric first arguments to the ``get`` subcommand."""
+
+    def resolve_command(self, ctx: typer.Context, args: list[str]) -> tuple:  # type: ignore[type-arg]
+        if args and args[0].isdigit() and args[0] not in self.commands:
+            args.insert(0, "get")
+        return super().resolve_command(ctx, args)
+
+
+def make_resource_app(*, help: str) -> typer.Typer:
+    """Create a Typer app that supports ``wbox <resource> <id>`` as shorthand for ``get <id>``."""
+    return typer.Typer(
+        cls=_GetShortcutGroup,
+        context_settings={"help_option_names": ["-h", "--help"]},
+        help=help,
+        no_args_is_help=True,
+    )
+
+
+# Maps CLI resource names to the CommentResourceType string expected by GET /comments
+COMMENT_RESOURCE_TYPES: dict[str, str] = {
+    "tasks": "Task",
+    "events": "Event",
+    "notes": "StatusUpdates",
+    "opportunities": "Opportunity",
+    "projects": "Project",
+    "workflows": "Workflow",
+}
+
+
 def get_client(token: str | None = None) -> WealthboxClient:
     """Create a WealthboxClient with token resolution: --token flag > env var > config file > .env."""
     import os
@@ -42,6 +73,95 @@ def run_client(token: str | None, fn: Callable[[WealthboxClient], Awaitable[Any]
     return asyncio.run(_execute())
 
 
+def run_client_with_comments(
+    token: str | None,
+    fn: Callable[[WealthboxClient], Awaitable[Any]],
+    resource_type: str,
+    resource_id: int,
+    include_comments: bool = True,
+) -> Any:
+    """Run an async client operation and optionally fetch + merge comments concurrently."""
+    async def _with_comments(client: WealthboxClient) -> Any:
+        if include_comments:
+            result, comments = await asyncio.gather(
+                fn(client),
+                client.get_comments_for_resource(resource_type, resource_id),
+            )
+            if isinstance(result, dict):
+                result["comments"] = comments
+        else:
+            result = await fn(client)
+        return result
+    return run_client(token, _with_comments)
+
+
+_COMMENT_PREVIEW_LEN = 50
+_SLIM_COMMENT_FIELDS = ("updated_at", "created_at", "creator")
+
+
+def _strip_html(text: str) -> str:
+    """Remove HTML tags and decode common HTML entities."""
+    import html
+    import re
+    return html.unescape(re.sub(r"<[^>]+>", "", text)).strip()
+
+
+def clean_comments(data: dict[str, Any]) -> dict[str, Any]:
+    """Strip HTML from body.text in each comment, keeping full structure (for verbose output)."""
+    comments = data.get("comments")
+    if not isinstance(comments, list):
+        return data
+    cleaned = []
+    for c in comments:
+        body = c.get("body")
+        if isinstance(body, dict) and "text" in body:
+            c = {**c, "body": {**body, "text": _strip_html(body["text"])}}
+        cleaned.append(c)
+    return {**data, "comments": cleaned}
+
+
+def slim_comments(data: dict[str, Any]) -> dict[str, Any]:
+    """Strip HTML, trim to essential fields, and unnest body.text → text (single pass)."""
+    comments = data.get("comments")
+    if not isinstance(comments, list):
+        return data
+    slimmed = []
+    for c in comments:
+        entry = {k: c[k] for k in _SLIM_COMMENT_FIELDS if k in c}
+        body = c.get("body")
+        raw = body.get("text", "") if isinstance(body, dict) else str(body or "")
+        entry["text"] = _strip_html(raw)
+        slimmed.append(entry)
+    return {**data, "comments": slimmed}
+
+
+def summarize_comments(data: dict[str, Any]) -> dict[str, Any]:
+    """Replace a ``comments`` list with ``comment_count`` and ``latest_comment`` summary fields."""
+    comments = data.get("comments")
+    if comments is None:
+        return data
+    data = {k: v for k, v in data.items() if k != "comments"}
+    data["comment_count"] = len(comments)
+    if comments:
+        newest = max(comments, key=lambda c: c.get("created_at", c.get("updated_at", "")))
+        text = newest.get("text", "")
+        preview = text[:_COMMENT_PREVIEW_LEN] + "..." if len(text) > _COMMENT_PREVIEW_LEN else text
+        data["latest_comment"] = preview
+    else:
+        data["latest_comment"] = ""
+    return data
+
+
+def output_get_result(
+    result: dict[str, Any], fmt: OutputFormat, fields: list[str] | None = None
+) -> None:
+    """Standard output pipeline for get commands with comments: slim → summarize → output."""
+    result = slim_comments(result)
+    if fmt != OutputFormat.JSON:
+        result = summarize_comments(result)
+    output_result(result, fmt, fields=fields)
+
+
 class OutputFormat(StrEnum):
     JSON = "json"
     TABLE = "table"
@@ -118,8 +238,12 @@ def _flatten_value(value: Any) -> Any:
                         return item["address"]
                 return first["address"]
             if "id" in first and "type" in first:
-                # e.g. linked_to, invitees
-                return f"{first['type']}:{first['id']}"
+                # e.g. linked_to, invitees — prefer name if available
+                parts = []
+                for item in value:
+                    name = item.get("name")
+                    parts.append(name if name else f"{item['type']}:{item['id']}")
+                return ", ".join(parts)
             return f"[{len(value)} items]"
     if isinstance(value, dict):
         return json.dumps(value)
@@ -143,10 +267,13 @@ def _extract_collection(data: Any) -> tuple[list[dict] | None, int | None]:  # t
                     break
             total = data["meta"].get("total_count") or data["meta"].get("total_entries")
             return rows, total
-        # Check if any value is a list (collection without meta)
-        for v in data.values():
-            if isinstance(v, list) and v and isinstance(v[0], dict):
-                return v, None
+        # Check if any value is a list (collection without meta).
+        # Skip when the dict looks like a single resource (has an "id" key) —
+        # nested lists like linked_to, subtasks, comments are not collections.
+        if "id" not in data:
+            for v in data.values():
+                if isinstance(v, list) and v and isinstance(v[0], dict):
+                    return v, None
     return None, None
 
 

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/contacts.py

@@ -22,16 +22,13 @@ from ._util import (
     active_to_status,
     handle_errors,
     make_category_command,
+    make_resource_app,
     output_result,
     parse_more_fields,
     run_client,
 )
 
-app = typer.Typer(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    help="Manage Wealthbox contacts.",
-    no_args_is_help=True,
-)
+app = make_resource_app(help="Manage Wealthbox contacts.")
 
 _DEFAULT_FIELDS = ["id", "name", "type", "contact_type", "assigned_to", "status"]
 

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/events.py

@@ -14,16 +14,26 @@ from wealthbox_tools.models import (
     TaskResourceType,
 )
 
-from ._util import OutputFormat, build_linked_to, handle_errors, make_category_command, output_result, run_client
-
-app = typer.Typer(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    help="Manage Wealthbox events.",
-    no_args_is_help=True,
+from ._util import (
+    COMMENT_RESOURCE_TYPES,
+    OutputFormat,
+    build_linked_to,
+    handle_errors,
+    make_category_command,
+    make_resource_app,
+    output_get_result,
+    output_result,
+    run_client,
+    run_client_with_comments,
 )
+
+app = make_resource_app(help="Manage Wealthbox events.")
 app.command("categories", help="List event category options.")(make_category_command(CategoryType.EVENT_CATEGORIES))
 
-_DEFAULT_FIELDS = ["id", "title", "starts_at", "ends_at", "state", "event_category"]
+_DEFAULT_FIELDS = [
+    "id", "title", "starts_at", "ends_at", "state", "event_category",
+    "comments", "comment_count", "latest_comment",
+]
 
 
 @app.command("list", help="List events with optional filters.")
@@ -71,11 +81,16 @@ def list_events(
 @handle_errors
 def get_event(
     event_id: int = typer.Argument(..., help="Event ID"),
+    no_comments: bool = typer.Option(False, "--no-comments", help="Omit comments from output"),
     verbose: bool = typer.Option(False, "--verbose", "-v", help="Show all fields"),
     token: str | None = typer.Option(None, envvar="WEALTHBOX_TOKEN", hidden=True),
     fmt: OutputFormat = typer.Option(OutputFormat.JSON, "--format"),
 ) -> None:
-    output_result(run_client(token, lambda c: c.get_event(event_id)), fmt, fields=None if verbose else _DEFAULT_FIELDS)
+    result = run_client_with_comments(
+        token, lambda c: c.get_event(event_id),
+        COMMENT_RESOURCE_TYPES["events"], event_id, include_comments=not no_comments,
+    )
+    output_get_result(result, fmt, fields=None if verbose else _DEFAULT_FIELDS)
 
 
 @app.command("add", help="Create a new event.")

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/main.py

@@ -6,7 +6,6 @@ import typer
 
 from .activity import app as activity_app
 from .categories import app as categories_app
-from .comments import app as comments_app
 from .config import app as config_app
 from .contacts import app as contacts_app
 from .events import app as events_app
@@ -38,7 +37,6 @@ def _main(
 app.add_typer(activity_app, name="activity")
 app.add_typer(categories_app, name="categories")
 app.add_typer(config_app, name="config")
-app.add_typer(comments_app, name="comments")
 app.add_typer(contacts_app, name="contacts")
 app.add_typer(events_app, name="events")
 app.add_typer(households_app, name="households")

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/notes.py

@@ -6,15 +6,25 @@ import typer
 
 from wealthbox_tools.models import NoteCreateInput, NoteListQuery, NoteResourceType, NotesOrder, NoteUpdateInput
 
-from ._util import OutputFormat, build_linked_to, handle_errors, output_result, run_client, truncate_field
-
-app = typer.Typer(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    help="Manage Wealthbox notes.",
-    no_args_is_help=True,
+from ._util import (
+    COMMENT_RESOURCE_TYPES,
+    OutputFormat,
+    build_linked_to,
+    handle_errors,
+    make_resource_app,
+    output_get_result,
+    output_result,
+    run_client,
+    run_client_with_comments,
+    truncate_field,
 )
 
-_DEFAULT_FIELDS = ["id", "content", "linked_to", "creator_id", "updated_at"]
+app = make_resource_app(help="Manage Wealthbox notes.")
+
+_DEFAULT_FIELDS = [
+    "id", "content", "linked_to", "creator_id", "updated_at",
+    "comments", "comment_count", "latest_comment",
+]
 _CONTENT_PREVIEW_LEN = 500
 
 
@@ -51,11 +61,16 @@ def list_notes(
 @handle_errors
 def get_note(
     note_id: int = typer.Argument(..., help="Note ID"),
+    no_comments: bool = typer.Option(False, "--no-comments", help="Omit comments from output"),
     verbose: bool = typer.Option(False, "--verbose", "-v", help="Show all fields"),
     token: str | None = typer.Option(None, envvar="WEALTHBOX_TOKEN", hidden=True),
     fmt: OutputFormat = typer.Option(OutputFormat.JSON, "--format"),
 ) -> None:
-    output_result(run_client(token, lambda c: c.get_note(note_id)), fmt, fields=None if verbose else _DEFAULT_FIELDS)
+    result = run_client_with_comments(
+        token, lambda c: c.get_note(note_id),
+        COMMENT_RESOURCE_TYPES["notes"], note_id, include_comments=not no_comments,
+    )
+    output_get_result(result, fmt, fields=None if verbose else _DEFAULT_FIELDS)
 
 
 @app.command("add", help="Create a new note.")

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/opportunities.py

@@ -13,15 +13,26 @@ from wealthbox_tools.models import (
     OpportunityUpdateInput,
 )
 
-from ._util import OutputFormat, build_linked_to, handle_errors, output_result, parse_more_fields, run_client
-
-app = typer.Typer(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    help="Manage Wealthbox opportunities.",
-    no_args_is_help=True,
+from ._util import (
+    COMMENT_RESOURCE_TYPES,
+    OutputFormat,
+    build_linked_to,
+    handle_errors,
+    make_resource_app,
+    output_get_result,
+    output_result,
+    parse_more_fields,
+    run_client,
+    run_client_with_comments,
 )
 
+app = make_resource_app(help="Manage Wealthbox opportunities.")
+
 _DEFAULT_FIELDS = ["id", "name", "stage", "probability", "target_close", "manager", "linked_to"]
+_MORE_FIELDS_RESERVED = {
+    "name", "target_close", "probability", "stage", "description",
+    "manager", "visible_to", "linked_to", "amounts",
+}
 
 
 def _build_amounts(
@@ -83,10 +94,15 @@ def list_opportunities(
 @handle_errors
 def get_opportunity(
     opportunity_id: int = typer.Argument(..., help="Opportunity ID"),
+    no_comments: bool = typer.Option(False, "--no-comments", help="Omit comments from output"),
     token: str | None = typer.Option(None, envvar="WEALTHBOX_TOKEN", hidden=True),
     fmt: OutputFormat = typer.Option(OutputFormat.JSON, "--format"),
 ) -> None:
-    output_result(run_client(token, lambda c: c.get_opportunity(opportunity_id)), fmt)
+    result = run_client_with_comments(
+        token, lambda c: c.get_opportunity(opportunity_id),
+        COMMENT_RESOURCE_TYPES["opportunities"], opportunity_id, include_comments=not no_comments,
+    )
+    output_get_result(result, fmt)
 
 
 @app.command("add", help="Create a new opportunity.")
@@ -125,11 +141,7 @@ def add_opportunity(
     }
 
     if more_fields:
-        _reserved = {
-            "name", "target_close", "probability", "stage", "description",
-            "manager", "visible_to", "linked_to", "amounts",
-        }
-        payload.update(parse_more_fields(more_fields, _reserved))
+        payload.update(parse_more_fields(more_fields, _MORE_FIELDS_RESERVED))
 
     input_model = OpportunityCreateInput(**{k: v for k, v in payload.items() if v is not None})
     output_result(run_client(token, lambda c: c.create_opportunity(input_model)), fmt)
@@ -178,11 +190,7 @@ def update_opportunity(
         payload["amounts"] = amounts
 
     if more_fields:
-        _update_reserved = {
-            "name", "target_close", "probability", "stage", "description",
-            "manager", "visible_to", "linked_to", "amounts",
-        }
-        payload.update(parse_more_fields(more_fields, _update_reserved))
+        payload.update(parse_more_fields(more_fields, _MORE_FIELDS_RESERVED))
 
     input_model = OpportunityUpdateInput(**payload)
     output_result(run_client(token, lambda c: c.update_opportunity(opportunity_id, input_model)), fmt)

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/projects.py

@@ -6,14 +6,20 @@ import typer
 
 from wealthbox_tools.models import ProjectCreateInput, ProjectListQuery, ProjectUpdateInput
 
-from ._util import OutputFormat, handle_errors, output_result, parse_more_fields, run_client
-
-app = typer.Typer(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    help="Manage Wealthbox projects.",
-    no_args_is_help=True,
+from ._util import (
+    COMMENT_RESOURCE_TYPES,
+    OutputFormat,
+    handle_errors,
+    make_resource_app,
+    output_get_result,
+    output_result,
+    parse_more_fields,
+    run_client,
+    run_client_with_comments,
 )
 
+app = make_resource_app(help="Manage Wealthbox projects.")
+
 _DEFAULT_FIELDS = ["id", "name", "description", "organizer", "updated_at"]
 
 
@@ -41,10 +47,15 @@ def list_projects(
 @handle_errors
 def get_project(
     project_id: int = typer.Argument(..., help="Project ID"),
+    no_comments: bool = typer.Option(False, "--no-comments", help="Omit comments from output"),
     token: str | None = typer.Option(None, envvar="WEALTHBOX_TOKEN", hidden=True),
     fmt: OutputFormat = typer.Option(OutputFormat.JSON, "--format"),
 ) -> None:
-    output_result(run_client(token, lambda c: c.get_project(project_id)), fmt)
+    result = run_client_with_comments(
+        token, lambda c: c.get_project(project_id),
+        COMMENT_RESOURCE_TYPES["projects"], project_id, include_comments=not no_comments,
+    )
+    output_get_result(result, fmt)
 
 
 @app.command("add", help="Create a new project.")

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/tasks.py

@@ -15,24 +15,37 @@ from wealthbox_tools.models import (
 )
 
 from ._util import (
+    COMMENT_RESOURCE_TYPES,
     OutputFormat,
     build_linked_to,
     build_resource_filter,
+    clean_comments,
     handle_errors,
     make_category_command,
+    make_resource_app,
     output_result,
     parse_more_fields,
     run_client,
+    run_client_with_comments,
+    slim_comments,
+    summarize_comments,
 )
 
-app = typer.Typer(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    help="Manage Wealthbox tasks.",
-    no_args_is_help=True,
-)
+app = make_resource_app(help="Manage Wealthbox tasks.")
 app.command("categories", help="List task category options.")(make_category_command(CategoryType.TASK_CATEGORIES))
 
 _DEFAULT_FIELDS = ["id", "name", "due_date", "frame", "complete", "category"]
+_GET_FIELDS = [
+    "id", "name", "description", "due_date", "created_at", "complete",
+    "priority", "assigned_to", "category", "linked_to",
+    "comment_count", "latest_comment",
+]
+_GET_JSON_FIELDS = [
+    "id", "name", "description", "due_date", "created_at", "updated_at",
+    "frame", "complete", "repeats", "priority",
+    "assigned_to", "assigned_to_team", "creator", "completer",
+    "category", "linked_to", "comments",
+]
 
 _TASK_CREATE_RESERVED = {"name", "due_date", "frame", "priority", "assigned_to", "linked_to"}
 
@@ -87,10 +100,25 @@ def list_tasks(
 @handle_errors
 def get_task(
     task_id: int = typer.Argument(..., help="Task ID"),
+    no_comments: bool = typer.Option(False, "--no-comments", help="Omit comments from output"),
+    verbose: bool = typer.Option(False, "--verbose", "-v", help="Show all fields"),
     token: str | None = typer.Option(None, envvar="WEALTHBOX_TOKEN", hidden=True),
     fmt: OutputFormat = typer.Option(OutputFormat.JSON, "--format"),
 ) -> None:
-    output_result(run_client(token, lambda c: c.get_task(task_id)), fmt)
+    result = run_client_with_comments(
+        token, lambda c: c.get_task(task_id),
+        COMMENT_RESOURCE_TYPES["tasks"], task_id, include_comments=not no_comments,
+    )
+    result = clean_comments(result)
+    if not verbose:
+        result = {k: result[k] for k in _GET_JSON_FIELDS if k in result}
+        result = slim_comments(result)
+    if fmt != OutputFormat.JSON:
+        result = summarize_comments(result)
+        desc = result.get("description", "")
+        if isinstance(desc, str) and len(desc) > 50:
+            result = {**result, "description": desc[:50] + "..."}
+    output_result(result, fmt, fields=None if (verbose or fmt == OutputFormat.JSON) else _GET_FIELDS)
 
 
 @app.command("add", help="Create a new task. Required: name, and either due_date or frame.")

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/cli/workflows.py

@@ -13,14 +13,21 @@ from wealthbox_tools.models import (
     WorkflowTemplateListQuery,
 )
 
-from ._util import OutputFormat, build_linked_to, handle_errors, output_result, parse_more_fields, run_client
-
-app = typer.Typer(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    help="Manage Wealthbox workflows.",
-    no_args_is_help=True,
+from ._util import (
+    COMMENT_RESOURCE_TYPES,
+    OutputFormat,
+    build_linked_to,
+    handle_errors,
+    make_resource_app,
+    output_get_result,
+    output_result,
+    parse_more_fields,
+    run_client,
+    run_client_with_comments,
 )
 
+app = make_resource_app(help="Manage Wealthbox workflows.")
+
 templates_app = typer.Typer(
     context_settings={"help_option_names": ["-h", "--help"]},
     help="List workflow templates.",
@@ -68,10 +75,15 @@ def list_workflows(
 @handle_errors
 def get_workflow(
     workflow_id: int = typer.Argument(..., help="Workflow ID"),
+    no_comments: bool = typer.Option(False, "--no-comments", help="Omit comments from output"),
     token: str | None = typer.Option(None, envvar="WEALTHBOX_TOKEN", hidden=True),
     fmt: OutputFormat = typer.Option(OutputFormat.JSON, "--format"),
 ) -> None:
-    output_result(run_client(token, lambda c: c.get_workflow(workflow_id)), fmt)
+    result = run_client_with_comments(
+        token, lambda c: c.get_workflow(workflow_id),
+        COMMENT_RESOURCE_TYPES["workflows"], workflow_id, include_comments=not no_comments,
+    )
+    output_get_result(result, fmt)
 
 
 @app.command("add", help="Create a new workflow from a template.")

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/client/comments.py

@@ -12,3 +12,11 @@ class CommentsMixin:
         params = query.model_dump(exclude_none=True) if query else None
         resp = await self._request("GET", "/comments", params=params)  # type: ignore[attr-defined]
         return resp.json()
+
+    async def get_comments_for_resource(
+        self, resource_type: str, resource_id: int
+    ) -> list[dict[str, Any]]:
+        """Fetch all comments for a specific resource."""
+        params = {"resource_type": resource_type, "resource_id": resource_id}
+        resp = await self._request("GET", "/comments", params=params)  # type: ignore[attr-defined]
+        return resp.json().get("comments", [])

{wealthbox_cli-1.0.0 → wealthbox_cli-1.0.2}/src/wealthbox_tools/models/enums.py

@@ -148,9 +148,16 @@ class NoteResourceType(StrEnum):
 
 
 class CommentResourceType(StrEnum):
-    CONTACT = "Contact"
     TASK = "Task"
     EVENT = "Event"
+    STATUS_UPDATES = "StatusUpdates" # Notes
+    # CONTACT = "Contact"
+    OPPORTUNITY = "Opportunity"
+    PROJECT = "Project"
+    WORKFLOW = "Workflow"
+    WORKFLOW_STEP = "WorkflowStep"
+    SELECTED_OUTCOME = "SelectedOutcome"
+    MEETING = "Meeting"
 
 
 class OpportunityResourceType(StrEnum):

wealthbox_cli-1.0.0/src/wealthbox_tools/cli/comments.py

@@ -1,51 +0,0 @@
-from __future__ import annotations
-
-import typer
-
-from wealthbox_tools.models import CommentListQuery, CommentResourceType
-
-from ._util import OutputFormat, handle_errors, output_result, run_client, truncate_nested_field
-
-app = typer.Typer(
-    context_settings={"help_option_names": ["-h", "--help"]},
-    help="Retrieve Wealthbox comments.",
-    no_args_is_help=True,
-)
-
-_DEFAULT_FIELDS = ["id", "creator", "resource_type", "resource_id", "created_at", "updated_at", "body"]
-_BODY_PREVIEW_LEN = 500
-
-
-@app.command("list", help="List comments. Filter by resource ID/type and/or updated date range.")
-@handle_errors
-def list_comments(
-    resource_id: int | None = typer.Option(
-        None, "--resource-id", help="Filter by resource ID (requires --resource-type)"
-    ),
-    resource_type: CommentResourceType | None = typer.Option(
-        None, "--resource-type", help="Filter by resource type: Contact, Task, Event"
-    ),
-    updated_since: str | None = typer.Option(
-        None, "--updated-since", help="Only comments updated on or after this timestamp"
-    ),
-    updated_before: str | None = typer.Option(
-        None, "--updated-before", help="Only comments updated on or before this timestamp"
-    ),
-    page: int | None = typer.Option(None),
-    per_page: int | None = typer.Option(None, "--per-page", help="Results per page (max 100)"),
-    verbose: bool = typer.Option(False, "--verbose", "-v", help="Show all fields"),
-    token: str | None = typer.Option(None, envvar="WEALTHBOX_TOKEN", hidden=True),
-    fmt: OutputFormat = typer.Option(OutputFormat.JSON, "--format"),
-) -> None:
-    query = CommentListQuery(
-        resource_id=resource_id,
-        resource_type=resource_type,
-        updated_since=updated_since,
-        updated_before=updated_before,
-        page=page,
-        per_page=per_page,
-    )
-    result = run_client(token, lambda c: c.list_comments(query))
-    if not verbose:
-        result = truncate_nested_field(result, "body", ["text", "html"], _BODY_PREVIEW_LEN)
-    output_result(result, fmt, fields=None if verbose else _DEFAULT_FIELDS)