pipecatcloud 0.1.2__tar.gz → 0.1.3__tar.gz

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3}/CHANGELOG.md

@@ -7,15 +7,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- `deploy` now correctly handles error states returned by the API
+
+- `deploy` checks revision status vs. general service ready status (when updating)
+
+### Added
+
+- `agent logs` now accepts a `--deployment_id` / `-d` argument for filtering 
+by specific deployment ID
+
+- `agent start` now accepts `--daily-properties` / `-p` for customizing Daily
+  room settings when used with `--use-daily`.
+
+- Added `daily_room_properties` to `SessionParams` in SDK for configuring Daily
+  rooms when creating sessions.
+
+- Added an export for the `PipecatSessionArguments` class.
+
+### Fixed
+
+- Fix an issue where custom `data` resulted in an agent not starting.
+
+- Fixed an issue where the link returned by `pcc agent start` was not clickable
+  in IDEs.
+
 ## [0.1.2] - 2025-03-12
 
 ### Added
 
-- `agent.py` data classes for use in base images, providing guidance on params
+- `agent.py` data classes for use in base images, providing guidance on params.
 
 ### Fixed
 
-- Lookup issue when passing an image pull secret to the `deploy` command
+- Lookup issue when passing an image pull secret to the `deploy` command.
 
 ### Changed
 

{pipecatcloud-0.1.2/src/pipecatcloud.egg-info → pipecatcloud-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pipecatcloud
-Version: 0.1.2
+Version: 0.1.3
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pipecatcloud"
-version = "0.1.2"
+version = "0.1.3"
 requires-python = ">=3.10"
 description = "Cloud hosting for Pipecat AI applications"
 license = { text = "BSD 2-Clause License" }

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3}/src/pipecatcloud/__init__.py

@@ -9,7 +9,12 @@ import sys
 
 from loguru import logger
 
-from pipecatcloud.agent import DailySessionArguments, SessionArguments, WebSocketSessionArguments
+from pipecatcloud.agent import (
+    DailySessionArguments,
+    PipecatSessionArguments,
+    SessionArguments,
+    WebSocketSessionArguments,
+)
 from pipecatcloud.exception import (
     AgentNotHealthyError,
     AgentStartError,
@@ -27,18 +32,19 @@ logger.add(sys.stderr, level=str(os.getenv("PCC_LOG_LEVEL", "INFO")))
 
 __all__ = [
     # Agent classes
-    "SessionArguments",
     "DailySessionArguments",
+    "PipecatSessionArguments",
+    "SessionArguments",
     "WebSocketSessionArguments",
     # Session classes
     "Session",
     "SessionParams",
     # Exception classes
-    "Error",
-    "ConfigFileError",
-    "AuthError",
-    "InvalidError",
-    "ConfigError",
     "AgentNotHealthyError",
     "AgentStartError",
+    "AuthError",
+    "ConfigError",
+    "ConfigFileError",
+    "Error",
+    "InvalidError",
 ]

pipecatcloud-0.1.3/src/pipecatcloud/__version__.py

@@ -0,0 +1,16 @@
+#
+# Copyright (c) 2025, Daily
+#
+# SPDX-License-Identifier: BSD 2-Clause License
+#
+
+try:
+    from importlib.metadata import version as get_version
+    version = get_version("pipecatcloud")
+except ImportError:
+    # For Python < 3.8
+    try:
+        from importlib_metadata import version as get_version
+        version = get_version("pipecatcloud")
+    except ImportError:
+        version = "Unknown"

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3}/src/pipecatcloud/_utils/console_utils.py

@@ -67,8 +67,7 @@ class PipecatConsole(Console):
                 title_align="left",
                 subtitle_align="left",
                 border_style="red",
-            )
-        )
+            ))
 
     def api_error(
         self,
@@ -79,7 +78,9 @@ class PipecatConsole(Console):
         DEFAULT_ERROR_MESSAGE = "Unknown error. Please contact support."
 
         if isinstance(error_code, dict):
-            error_message = error_code.get("error", DEFAULT_ERROR_MESSAGE)
+            error_message = error_code.get(
+                "error", None) or error_code.get(
+                "message", None) or DEFAULT_ERROR_MESSAGE
             code = error_code.get("code")
         else:
             error_message = str(error_code) if error_code else DEFAULT_ERROR_MESSAGE

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3}/src/pipecatcloud/api.py

@@ -4,8 +4,9 @@
 # SPDX-License-Identifier: BSD 2-Clause License
 #
 
+import json
 from functools import wraps
-from typing import Callable, List, Optional
+from typing import Callable, List, Optional, Union
 
 import aiohttp
 from loguru import logger
@@ -368,13 +369,24 @@ class _API:
         return self.create_api_method(self._agents)
 
     async def _start_agent(
-        self, agent_name: str, api_key: str, use_daily: bool, data: Optional[str] = None
+        self,
+        agent_name: str,
+        api_key: str,
+        use_daily: bool,
+        data: Optional[str] = None,
+        daily_properties: Optional[str] = None,
     ) -> dict | None:
         url = f"{self.construct_api_url('start_path').format(service=agent_name)}"
 
         payload: dict = {"createDailyRoom": use_daily}
+
+        # Add data to payload if provided
         if data is not None:
-            payload["body"] = data
+            payload["body"] = json.loads(data)
+
+        # Add Daily room properties only if use_daily is True
+        if use_daily and daily_properties:
+            payload["dailyRoomProperties"] = json.loads(daily_properties)
 
         return await self._base_request(
             "POST", url, override_token=api_key, json=payload, not_found_is_empty=True
@@ -392,9 +404,13 @@ class _API:
     def agent_delete(self):
         return self.create_api_method(self._agent_delete)
 
-    async def _agent_logs(self, agent_name: str, org: str, limit: int = 100) -> dict | None:
+    async def _agent_logs(self, agent_name: str, org: str, limit: int = 100,
+                          deployment_id: Optional[str] = None) -> dict | None:
         url = f"{self.construct_api_url('services_logs_path').format(org=org, service=agent_name)}"
-        return await self._base_request("GET", url, params={"limit": limit})
+        params: dict[str, Union[int, str]] = {"limit": limit}
+        if deployment_id:
+            params["deploymentId"] = deployment_id
+        return await self._base_request("GET", url, params=params)
 
     @property
     def agent_logs(self):

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3}/src/pipecatcloud/cli/commands/agent.py

@@ -42,16 +42,19 @@ async def list(
 ):
     org = organization or config.get("org")
 
-    with console.status(f"[dim]Fetching agents for organization: [bold]'{org}'[/bold][/dim]", spinner="dots"):
+    with console.status(
+        f"[dim]Fetching agents for organization: [bold]'{org}'[/bold][/dim]", spinner="dots"
+    ):
         data, error = await API.agents(org=org)
 
         if error:
-            typer.Exit()
+            return typer.Exit()
 
         if not data or len(data) == 0:
             console.error(
                 f"[red]No agents found for namespace / organization '{org}'[/red]\n\n"
-                f"[dim]Please deploy an agent first using[/dim] [bold cyan]{PIPECAT_CLI_NAME} deploy[/bold cyan]")
+                f"[dim]Please deploy an agent first using[/dim] [bold cyan]{PIPECAT_CLI_NAME} deploy[/bold cyan]"
+            )
             return typer.Exit(1)
 
         else:
@@ -92,6 +95,8 @@ async def status(
     ) as live:
         data, error = await API.agent(agent_name=agent_name, org=org, live=live)
 
+        logger.debug(f"Agent status: {data}")
+
         live.stop()
 
         if error:
@@ -147,6 +152,25 @@ async def status(
                 border_style="dim",
             )
 
+        # Error status
+        error_panel = None
+        errors = data.get("errors", [])
+        if errors and len(errors) > 0:
+            error_table = Table(show_header=False, show_lines=False, box=box.SIMPLE)
+            error_table.add_column("Code")
+            error_table.add_column("Message")
+            for error in errors:
+                error_table.add_row(
+                    f"[bold red]{error['code']}[/bold red]",
+                    f"[red]{error.get('message', None) or error.get('error', 'Unknown error')}[/red]",
+                )
+            error_panel = Panel(
+                error_table,
+                title="[bold red]Agent errors:[/bold red]",
+                title_align="left",
+                border_style="red",
+            )
+
         color = "bold green" if data["ready"] else "bold yellow"
         subtitle = (
             f"[dim]Start a new active session with[/dim] [bold cyan]{PIPECAT_CLI_NAME} agent start {agent_name}[/bold cyan]"
@@ -163,6 +187,7 @@ async def status(
                         border_style="green" if data["ready"] else "yellow",
                         expand=False,
                     ),
+                    error_panel if error_panel else "",
                 ),
                 title=f"Status for agent [bold]{agent_name}[/bold]",
                 title_align="left",
@@ -246,30 +271,51 @@ class LogLevelColors(str, Enum):
 @synchronizer.create_blocking
 @requires_login
 async def logs(
-    agent_name: str,
-    organization: str = typer.Option(
-        None, "--organization", "-o", help="Organization to get status of agent for"
-    ),
-    level: LogLevel = typer.Option(None, "--level", "-l", help="Level of logs to get"),
-    format: LogFormat = typer.Option(LogFormat.TEXT, "--format", "-f", help="Logs format"),
-    limit: int = typer.Option(100, "--limit", "-n", help="Number of logs to get"),
+        agent_name: str,
+        organization: str = typer.Option(
+            None,
+            "--organization",
+            "-o",
+            help="Organization to get status of agent for"),
+        level: LogLevel = typer.Option(
+            None,
+            "--level",
+            "-l",
+            help="Level of logs to get"),
+        format: LogFormat = typer.Option(
+            LogFormat.TEXT,
+            "--format",
+            "-f",
+            help="Logs format"),
+        limit: int = typer.Option(
+            100,
+            "--limit",
+            "-n",
+            help="Number of logs to get"),
+        deployment_id: str = typer.Option(
+            None,
+            "--deployment",
+            "-d",
+            help="Filter logs by deployment ID"),
 ):
     org = organization or config.get("org")
 
+    status_text = "agent" if not deployment_id else f"deployment ({deployment_id})"
+
     with console.status(
-        f"[dim]Fetching logs for agent: [bold]'{agent_name}'[/bold] with severity: [bold cyan]{level.value if level else 'ALL'}[/bold cyan][/dim]",
+        f"[dim]Fetching logs for {status_text}: [bold]'{agent_name}'[/bold] with severity: [bold cyan]{level.value if level else 'ALL'}[/bold cyan][/dim]",
         spinner="dots",
     ):
-        data, error = await API.agent_logs(agent_name=agent_name, org=org, limit=limit)
+        data, error = await API.agent_logs(agent_name=agent_name, org=org, limit=limit, deployment_id=deployment_id)
 
         if not data or not data.get("logs"):
             console.print("[dim]No logs found for agent[/dim]")
             return typer.Exit(1)
 
-    for l in data["logs"]:
-        log_data = l.get("log", "")
+    for log in data["logs"]:
+        log_data = log.get("log", "")
         if log_data:
-            timestamp = format_timestamp(l.get("timestamp", ""))
+            timestamp = format_timestamp(log.get("timestamp", ""))
             severity = LogLevel.INFO
             for log_severity in LogLevel:
                 if log_severity.value in log_data.upper():
@@ -282,9 +328,9 @@ async def logs(
             if format == LogFormat.TEXT:
                 color = getattr(LogLevelColors, severity, LogLevelColors.DEBUG).value
                 console.print(Text(timestamp, style="bold dim"), end=" ")
-                console.print(Text(l.get("log", ""), style=color))
+                console.print(Text(log_data, style=color))
             elif format == LogFormat.JSON:
-                line = {"timestamp": timestamp, "log": l.get("log", "")}
+                line = {"timestamp": timestamp, "log": log_data}
                 console.print(Text(json.dumps(line, ensure_ascii=False), style="gray"))
 
 
@@ -427,6 +473,13 @@ async def start(
         help="Create a Daily WebRTC session for the agent",
         rich_help_panel="Start Configuration",
     ),
+    daily_properties: str = typer.Option(
+        None,
+        "--daily-properties",
+        "-p",
+        help="Daily room properties (stringified JSON)",
+        rich_help_panel="Start Configuration",
+    ),
     organization: str = typer.Option(
         None,
         "--organization",
@@ -449,22 +502,39 @@ async def start(
                 title="Public API Key Required",
                 title_align="left",
                 border_style="yellow",
-            ))
+            )
+        )
 
         return typer.Exit(1)
 
+    # Validate daily_properties JSON if provided
+    if use_daily and daily_properties:
+        try:
+            json.loads(daily_properties)
+        except json.JSONDecodeError as e:
+            console.error(f"Invalid JSON format for Daily room properties: {daily_properties}")
+            console.print(f"[dim]JSON error: {str(e)}[/dim]")
+            return typer.Exit(1)
+
     # Confirm start request
     if not force:
+        daily_props_display = daily_properties or "None"
+        # Truncate display of daily properties if too long
+        if daily_properties and len(daily_properties) > 80:
+            daily_props_display = daily_properties[:77] + "..."
+
         console.print(
             Panel(
                 f"Agent Name: {agent_name}\n"
                 f"Public API Key: {default_public_api_key_name} [dim]{default_public_api_key}[/dim]\n"
                 f"Use Daily: {use_daily}\n"
+                f"Daily Properties: {daily_props_display}\n"
                 f"Data: {data}",
                 title=f"[bold]Start Request for agent: {agent_name}[/bold]",
                 title_align="left",
                 border_style="yellow",
-            ))
+            )
+        )
         if not await questionary.confirm(
             "Are you sure you want to start an active session for this agent?"
         ).ask_async():
@@ -494,10 +564,13 @@ async def start(
             api_key=default_public_api_key,
             use_daily=use_daily,
             data=data,
+            daily_properties=daily_properties,
             live=live,
         )
 
         if error:
+            live.stop()
+            # Error is displayed from start_agent create_api_method wrapper
             return typer.Exit(1)
 
         live.stop()
@@ -509,4 +582,4 @@ async def start(
             if daily_room:
                 url = f"{daily_room}?t={daily_token}"
                 console.print("\nJoin your session by visiting the link below:")
-                console.print(f"[link='{url}']{url}[/link]")
+                console.print(f"[link={url}]{url}[/link]")

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3}/src/pipecatcloud/cli/commands/deploy.py

@@ -7,6 +7,7 @@
 import asyncio
 
 import typer
+from loguru import logger
 from rich.console import Group
 from rich.live import Live
 from rich.panel import Panel
@@ -131,7 +132,6 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
     # 3. Poll status until healthy
     """
     active_deployment_id = None
-    has_failed = False
     is_ready = False
     checks_performed = 0
 
@@ -145,23 +145,44 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
     ) as status:
         try:
             while checks_performed < MAX_ALIVE_CHECKS:
+                logger.debug("Polling for deployment status")
+
                 # Get deployment status
                 agent_status, error = await API.agent(
                     agent_name=params.agent_name, org=org, live=None
                 )
 
+                logger.debug(f"Deployment status: {agent_status}")
+
+                # Look for any error messages in the agent status
+                # Exit out of the polling loop if we find an error
+                status_errors = agent_status.get("errors", [])
+                if status_errors and len(status_errors) > 0:
+                    status.stop()
+                    # Pluck the first error message
+                    error_message = status_errors[0]
+                    if "code" in error_message and "message" in error_message:
+                        console.api_error(error_message, "Agent deployment failed")
+                    else:
+                        console.error(f"Deployment failed with an unknown error: {status_errors}")
+                    return typer.Exit()
+
                 if error:
                     status.stop()
                     console.error("Error checking deployment status")
                     return typer.Exit()
 
-                # Update deployment ID if received (silently)
+                # Update deployment ID if received
                 if not active_deployment_id and agent_status.get("activeDeploymentId"):
                     active_deployment_id = agent_status["activeDeploymentId"]
                     deployment_status_message = f"[dim]Waiting for deployment to become ready (deployment ID: {active_deployment_id})...[/dim]"
+                    status.update(deployment_status_message)
+
+                # If we have an active deployment ID, start tailing the log output
+                # @TODO - Implement this
 
                 # Check if deployment is ready
-                if agent_status.get("ready"):
+                if agent_status.get("activeDeploymentReady", False):
                     is_ready = True
                     break
 
@@ -176,43 +197,24 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
             )
             return typer.Exit()
 
-    # Final result handling
-    if has_failed:
-        console.print(has_failed["message"])
-        console.error("Deployment failed with the above error")
-        return typer.Exit()
-
-    # check for org secret
-    default_public_api_key = config.get("default_public_key")
-
     if is_ready:
-        if not default_public_api_key:
-            console.print(
-                Panel(
-                    f"No public API key provided. Please provide a public API key using the --api-key flag or set a default using [bold cyan]{PIPECAT_CLI_NAME} organizations keys use[/bold cyan].\n\n"
-                    f"If you have not yet created a public API key, you can do so by running [bold cyan]{PIPECAT_CLI_NAME} organizations keys create[/bold cyan].\n\n"
-                    f"Then...\n\n"
-                    f"[dim]Start a session with your new agent by running:\n[/dim]"
-                    f"[bold]`{PIPECAT_CLI_NAME} agent start {params.agent_name}`[/bold]",
-                    title="Public API Key Required",
-                    title_align="left",
-                    border_style="yellow",
-                )
-            )
-
-            return typer.Exit(1)
-        else:
-            console.success(
-                f"Agent deployment [bold]'{params.agent_name}'[/bold] is ready\n\n"
-                f"[dim]Start a session with your new agent by running:\n[/dim]"
-                f"[bold]`{PIPECAT_CLI_NAME} agent start {params.agent_name}`[/bold]",
-                title_extra=f"{'Update' if existing_agent else 'Deployment'} complete",
-            )
+        public_api_key = config.get("default_public_key")
+        extra_message = ""
+        if not public_api_key:
+            extra_message = "\n\n[yellow]Note: if you have not already created a public API key (required to start a session), you can do so by running:\n[/yellow]"
+            extra_message += f"[bold yellow]`{PIPECAT_CLI_NAME} organizations keys create`[/bold yellow]"
+
+        console.success(
+            f"Agent deployment [bold]'{params.agent_name}'[/bold] is ready\n\n"
+            f"[white]Start a session with your new agent by running:\n[/white]"
+            f"[bold]`{PIPECAT_CLI_NAME} agent start {params.agent_name}`[/bold]"
+            f"{extra_message}",
+            title_extra=f"{'Update' if existing_agent else 'Deployment'} complete",
+        )
     else:
         console.error(
             f"Deployment did not enter ready state within {MAX_ALIVE_CHECKS * ALIVE_CHECK_SLEEP} seconds. "
-            f"Please check logs with `{PIPECAT_CLI_NAME} agent logs {params.agent_name}`"
-        )
+            f"Please check logs with `{PIPECAT_CLI_NAME} agent logs {params.agent_name}`")
 
     return typer.Exit()
 
@@ -325,24 +327,17 @@ def create_deploy_command(app: typer.Typer):
             (f"[bold white]Agent name:[/bold white] [green]{partial_config.agent_name}[/green]"),
             (f"[bold white]Image:[/bold white] [green]{partial_config.image}[/green]"),
             (f"[bold white]Organization:[/bold white] [green]{org}[/green]"),
-            (
-                f"[bold white]Secret set:[/bold white] {'[dim]None[/dim]' if not partial_config.secret_set else '[green] '+ partial_config.secret_set + '[/green]'}"
-            ),
-            (
-                f"[bold white]Image pull secret:[/bold white] {'[dim]None[/dim]' if not partial_config.image_credentials else '[green]' + partial_config.image_credentials + '[/green]'}"
-            ),
+            (f"[bold white]Secret set:[/bold white] {'[dim]None[/dim]' if not partial_config.secret_set else '[green] '+ partial_config.secret_set + '[/green]'}"),
+            (f"[bold white]Image pull secret:[/bold white] {'[dim]None[/dim]' if not partial_config.image_credentials else '[green]' + partial_config.image_credentials + '[/green]'}"),
             "\n[dim]Scaling configuration:[/dim]",
             table,
-            *(
-                []
-                if partial_config.scaling.min_instances
-                else [
+            *
+            (
+                [] if partial_config.scaling.min_instances else [
                     Text(
                         "Note: Deploying with 0 minimum instances may result in cold starts",
                         style="red",
-                    )
-                ]
-            ),
+                    )]),
         )
 
         console.print(

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3}/src/pipecatcloud/session.py

@@ -21,10 +21,14 @@ class SessionParams:
     Args:
         data: Optional dictionary of data to pass to the agent.
         use_daily: If True, creates a Daily WebRTC room for the session.
+        daily_room_properties: Optional dictionary of properties to configure the Daily room.
+            Only used when use_daily=True. See Daily.co API documentation for available properties:
+            https://docs.daily.co/reference/rest-api/rooms/config
     """
 
     data: Optional[Dict[str, Any]] = None
     use_daily: Optional[bool] = False
+    daily_room_properties: Optional[Dict[str, Any]] = None
 
 
 class Session:
@@ -90,12 +94,23 @@ class Session:
                 # If it's already a string or other type, use as is
                 data_param = self.params.data
 
+        # Only process daily_room_properties if use_daily is True
+        daily_properties_param = None
+        if self.params.use_daily and self.params.daily_room_properties:
+            # Convert dictionary to JSON string
+            if isinstance(self.params.daily_room_properties, dict):
+                daily_properties_param = json.dumps(self.params.daily_room_properties)
+            else:
+                # If it's already a string, use as is
+                daily_properties_param = self.params.daily_room_properties
+
         # Call the method similar to how the CLI does it
         result, error = await api.start_agent(
             agent_name=self.agent_name,
             api_key=self.api_key,
             use_daily=bool(self.params.use_daily),
             data=data_param,
+            daily_properties=daily_properties_param,
         )
 
         if error:

{pipecatcloud-0.1.2 → pipecatcloud-0.1.3/src/pipecatcloud.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pipecatcloud
-Version: 0.1.2
+Version: 0.1.3
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/

pipecatcloud-0.1.2/src/pipecatcloud/__version__.py

@@ -1,12 +0,0 @@
-#
-# Copyright (c) 2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-from pathlib import Path
-
-import toml
-
-pyproject_path = Path(__file__).parent.parent.parent / "pyproject.toml"
-version = toml.load(pyproject_path)["project"]["version"]