pipecatcloud 0.1.4__tar.gz → 0.1.6__tar.gz

{pipecatcloud-0.1.4 → pipecatcloud-0.1.6}/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.6] - 2025-04-25
+
+# Changed
+
+- `min-instances` and `max-instances` has been changed to reflect API terminology changes.
+
+## [0.1.5] - 2025-04-09
+
+# Added
+
+- `deploy` command now accepts a `--enable-krisp / -krisp` which enables Krisp integration for your pipeline.
+
+# Changed
+
+- `start` command now takes agent name from `pcc-deploy.toml` where applicable 
+- API error handling now checks `response.ok` and properly checks for error codes for all non-ok responses
+
+# Fixed
+
+- REST and cURL requests now render errors correctly
+
+
 ## [0.1.4] - 2025-03-28
 
 ### Changed

{pipecatcloud-0.1.4/src/pipecatcloud.egg-info → pipecatcloud-0.1.6}/PKG-INFO

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

{pipecatcloud-0.1.4 → pipecatcloud-0.1.6}/pyproject.toml

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

{pipecatcloud-0.1.4 → pipecatcloud-0.1.6}/src/pipecatcloud/_utils/deploy_utils.py

@@ -5,10 +5,11 @@
 #
 
 import os
-from typing import Optional
+import functools
+from typing import Optional, Callable, Any
 
 import toml
-from attr import dataclass
+from attr import dataclass, field
 from loguru import logger
 
 from pipecatcloud.exception import ConfigFileError
@@ -22,23 +23,37 @@ DEPLOY_STATUS_MAP = {
 
 @dataclass
 class ScalingParams:
-    min_instances: Optional[int] = 0
-    max_instances: Optional[int] = 10
+    min_agents: Optional[int] = 0
+    max_agents: Optional[int] = None
+    # @deprecated
+    min_instances: Optional[int] = field(default=None, metadata={"deprecated": True})
+    # @deprecated
+    max_instances: Optional[int] = field(default=None, metadata={"deprecated": True})
 
     def __attrs_post_init__(self):
+        # Handle deprecated fields
         if self.min_instances is not None:
-            if self.min_instances < 0:
-                raise ValueError("min_instances must be greater than or equal to 0")
+            logger.warning("min_instances is deprecated, use min_agents instead")
+            self.min_agents = self.min_instances
 
         if self.max_instances is not None:
-            if self.max_instances < 1:
-                raise ValueError("max_instances must be greater than 0")
+            logger.warning("max_instances is deprecated, use max_agents instead")
+            self.max_agents = self.max_instances
 
-            if self.min_instances is not None and self.max_instances < self.min_instances:
-                raise ValueError("max_instances must be greater than or equal to min_instances")
+        # Validation
+        if self.min_agents is not None:
+            if self.min_agents < 0:
+                raise ValueError("min_agents must be greater than or equal to 0")
+
+        if self.max_agents is not None:
+            if self.max_agents < 1:
+                raise ValueError("max_agents must be greater than 0")
+
+            if self.min_agents is not None and self.max_agents < self.min_agents:
+                raise ValueError("max_agents must be greater than or equal to min_agents")
 
     def to_dict(self):
-        return {"min_instances": self.min_instances, "max_instances": self.max_instances}
+        return {"min_agents": self.min_agents, "max_agents": self.max_agents}
 
 
 @dataclass
@@ -48,6 +63,7 @@ class DeployConfigParams:
     image_credentials: Optional[str] = None
     secret_set: Optional[str] = None
     scaling: ScalingParams = ScalingParams()
+    enable_krisp: bool = False
 
     def __attrs_post_init__(self):
         if self.image is not None and ":" not in self.image:
@@ -60,6 +76,7 @@ class DeployConfigParams:
             "image_credentials": self.image_credentials,
             "secret_set": self.secret_set,
             "scaling": self.scaling.to_dict() if self.scaling else None,
+            "enable_krisp": self.enable_krisp,
         }
 
 
@@ -87,7 +104,14 @@ def load_deploy_config_file() -> Optional[DeployConfigParams]:
         )
 
         # Check for unexpected keys
-        expected_keys = {"agent_name", "image", "image_credentials", "secret_set", "scaling"}
+        expected_keys = {
+            "agent_name",
+            "image",
+            "image_credentials",
+            "secret_set",
+            "scaling",
+            "enable_krisp",
+        }
         unexpected_keys = set(config_data.keys()) - expected_keys
         if unexpected_keys:
             raise ConfigFileError(f"Unexpected keys in config file: {unexpected_keys}")
@@ -97,3 +121,20 @@ def load_deploy_config_file() -> Optional[DeployConfigParams]:
     except Exception as e:
         logger.debug(e)
         raise ConfigFileError(str(e))
+
+
+def with_deploy_config(func: Callable) -> Callable:
+    """
+    Decorator that loads the deploy config file and injects it into the function.
+    If the config file exists, it will be loaded and passed to the function as `deploy_config`.
+    """
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        try:
+            deploy_config = load_deploy_config_file()
+            kwargs['deploy_config'] = deploy_config
+        except Exception as e:
+            logger.error(f"Error loading deploy config: {e}")
+            raise ConfigFileError(str(e))
+        return func(*args, **kwargs)
+    return wrapper

{pipecatcloud-0.1.4 → pipecatcloud-0.1.6}/src/pipecatcloud/api.py

@@ -13,6 +13,7 @@ from loguru import logger
 
 from pipecatcloud._utils.deploy_utils import DeployConfigParams
 from pipecatcloud.config import config
+from pipecatcloud.exception import AgentStartError
 
 
 def api_method(func):
@@ -30,10 +31,11 @@ def api_method(func):
 
 
 class _API:
-    def __init__(self, token: Optional[str] = None):
+    def __init__(self, token: Optional[str] = None, is_cli: bool = False):
         self.token = token
         self.error = None
         self.bubble_next = False
+        self.is_cli = is_cli
 
     @staticmethod
     def construct_api_url(path: str) -> str:
@@ -60,6 +62,8 @@ class _API:
         override_token: Optional[str] = None,
     ) -> Optional[dict]:
         async with aiohttp.ClientSession() as session:
+            logger.debug(f"Request: {method} {url} {params} {json}")
+
             response = await session.request(
                 method=method,
                 url=url,
@@ -67,21 +71,23 @@ class _API:
                 params=params,
                 json=json,
             )
+
             if not response.ok:
-                if not_found_is_empty and response.status == 404:
+                logger.debug(f"Response not ok: {response.status} {response.reason}")
+                if self.is_cli and not_found_is_empty and response.status == 404:
                     return None
 
                 # Extract PCC error code, where applicable
-                if response.status == 400:
-                    try:
-                        error_data = await response.json()
-                        self.error = error_data
-                    except Exception:
-                        # Fallback structure matching API format
-                        self.error = {"error": "Bad Request", "code": str(response.status)}
-                else:
-                    # Match API error format for non-400 errors
-                    self.error = {"error": response.reason, "code": str(response.status)}
+                try:
+                    # Try to parse the error as JSON
+                    error_data = await response.json()
+                    self.error = error_data
+                except Exception:
+                    # Fallback structure matching API format
+                    self.error = {
+                        "error": response.reason or "Bad Request",
+                        "code": str(
+                            response.status)}
                 response.raise_for_status()
 
             return await response.json()
@@ -100,6 +106,12 @@ class _API:
                 if live and not self.bubble_next:
                     live.stop()
 
+                if not self.is_cli and self.error and not self.bubble_next:
+                    if isinstance(self.error, dict) and self.error.get("status", "429"):
+                        raise AgentStartError(self.error)
+                    else:
+                        raise e
+
                 if self.error and not self.bubble_next:
                     logger.debug(e)
                     self.print_error()
@@ -305,9 +317,10 @@ class _API:
             "imagePullSecretSet": deploy_config.image_credentials,
             "secretSet": deploy_config.secret_set,
             "autoScaling": {
-                "minReplicas": deploy_config.scaling.min_instances,
-                "maxReplicas": deploy_config.scaling.max_instances,
+                "minAgents": deploy_config.scaling.min_agents,
+                "maxAgents": deploy_config.scaling.max_agents,
             },
+            "enableKrisp": deploy_config.enable_krisp,
         }
 
         # Remove None values recursively

{pipecatcloud-0.1.4 → pipecatcloud-0.1.6}/src/pipecatcloud/cli/api.py

@@ -7,4 +7,4 @@
 from pipecatcloud.api import _API
 from pipecatcloud.cli.config import config
 
-API = _API(config.get("token"))
+API = _API(config.get("token"), is_cli=True)

{pipecatcloud-0.1.4 → pipecatcloud-0.1.6}/src/pipecatcloud/cli/commands/agent.py

@@ -25,6 +25,7 @@ from pipecatcloud._utils.console_utils import console, format_timestamp
 from pipecatcloud.cli import PIPECAT_CLI_NAME
 from pipecatcloud.cli.api import API
 from pipecatcloud.cli.config import config
+from pipecatcloud._utils.deploy_utils import with_deploy_config, DeployConfigParams
 
 agent_cli = typer.Typer(name="agent", help="Agent management", no_args_is_help=True)
 
@@ -53,8 +54,7 @@ async def list(
         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:
@@ -137,11 +137,11 @@ async def status(
         if autoscaling_data:
             scaling_renderables = [
                 Panel(
-                    f"[bold]Minimum Instances[/bold]\n{autoscaling_data.get('minReplicas', 0)}",
+                    f"[bold]Minimum Agents[/bold]\n{autoscaling_data.get('minAgents', 0)}",
                     expand=True,
                 ),
                 Panel(
-                    f"[bold]Maximum Instances[/bold]\n{autoscaling_data.get('maxReplicas', 0)}",
+                    f"[bold]Maximum Agents[/bold]\n{autoscaling_data.get('maxAgents', 0)}",
                     expand=True,
                 ),
             ]
@@ -443,8 +443,10 @@ async def deployments(
 @agent_cli.command(name="start", help="Start an agent instance")
 @synchronizer.create_blocking
 @requires_login
+@with_deploy_config
 async def start(
-    agent_name: str = typer.Argument(help="Name of the agent to start e.g. 'my-agent'"),
+    deploy_config=typer.Option(None, hidden=True),
+    agent_name: str = typer.Argument(None, help="Name of the agent to start e.g. 'my-agent'"),
     force: bool = typer.Option(
         False,
         "--force",
@@ -494,6 +496,19 @@ async def start(
         "CLI provided" if api_key else config.get("default_public_key_name")
     )
 
+    # Load values from deployment config file (if one exists)
+    partial_config = deploy_config or DeployConfigParams()
+
+    # Get agent name from pcc-deploy.toml if not provided
+    if not agent_name:
+        default_agent_name = partial_config.agent_name
+
+        if not default_agent_name:
+            console.error("No target agent name provided")
+            return typer.Exit(1)
+
+        agent_name = default_agent_name
+
     if not default_public_api_key:
         console.print(
             Panel(
@@ -502,8 +517,7 @@ async def start(
                 title="Public API Key Required",
                 title_align="left",
                 border_style="yellow",
-            )
-        )
+            ))
 
         return typer.Exit(1)
 
@@ -533,8 +547,7 @@ async def start(
                 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():

{pipecatcloud-0.1.4 → pipecatcloud-0.1.6}/src/pipecatcloud/cli/commands/deploy.py

@@ -20,7 +20,7 @@ from pipecatcloud._utils.console_utils import console
 from pipecatcloud._utils.deploy_utils import (
     DeployConfigParams,
     ScalingParams,
-    load_deploy_config_file,
+    with_deploy_config,
 )
 from pipecatcloud.cli import PIPECAT_CLI_NAME
 from pipecatcloud.cli.api import API
@@ -223,26 +223,28 @@ def create_deploy_command(app: typer.Typer):
     @app.command(name="deploy", help="Deploy agent to Pipecat Cloud")
     @synchronizer.create_blocking
     @requires_login
+    @with_deploy_config
     async def deploy(
+        deploy_config=typer.Option(None, hidden=True),
         agent_name: str = typer.Argument(
             None, help="Name of the agent to deploy e.g. 'my-agent'", show_default=False
         ),
         image: str = typer.Argument(
             None, help="Docker image location e.g. 'my-image:latest'", show_default=False
         ),
-        min_instances: int = typer.Option(
+        min_agents: int = typer.Option(
             None,
-            "--min-instances",
+            "--min-agents",
             "-min",
-            help="Minimum number of instances to keep warm",
+            help="Minimum number of agents to keep warm",
             rich_help_panel="Deployment Configuration",
             min=0,
         ),
-        max_instances: int = typer.Option(
+        max_agents: int = typer.Option(
             None,
-            "--max-instances",
+            "--max-agents",
             "-max",
-            help="Maximum number of allowed instances",
+            help="Maximum number of allowed agents",
             rich_help_panel="Deployment Configuration",
             min=1,
             max=50,
@@ -268,13 +270,47 @@ def create_deploy_command(app: typer.Typer):
             help="Image pull secret to use for deployment",
             rich_help_panel="Deployment Configuration",
         ),
+        krisp: bool = typer.Option(
+            False,
+            "--enable-krisp",
+            "-krisp",
+            help="Enable Krisp integration for this deployment",
+            rich_help_panel="Deployment Configuration",
+        ),
         skip_confirm: bool = typer.Option(
             False,
             "--force",
             "-f",
             help="Force deployment / skip confirmation",
         ),
+        # @deprecated
+        min_instances: int = typer.Option(
+            None,
+            "--min-instances",
+            help="[Deprecated] Use --min-agents instead",
+            hidden=True,
+            min=0,
+        ),
+        # @deprecated
+        max_instances: int = typer.Option(
+            None,
+            "--max-instances",
+            help="[Deprecated] Use --max-agents instead",
+            hidden=True,
+            min=1,
+            max=50,
+        ),
     ):
+
+        # Handle @deprecated options
+        if min_instances is not None:
+            logger.warning("min_instances is deprecated, use min_agents instead")
+            min_agents = min_instances
+
+        if max_instances is not None:
+            logger.warning("max_instances is deprecated, use max_agents instead")
+            max_agents = max_instances
+
         org = organization or config.get("org")
 
         # Compose deployment config from CLI options and config file (if provided)
@@ -283,15 +319,7 @@ def create_deploy_command(app: typer.Typer):
         #   2. Values from the config toml file
         #   3. CLI command defaults
 
-        partial_config = DeployConfigParams()
-
-        # Load values from deployment config file (if one exists)
-        try:
-            if deploy_config := load_deploy_config_file():
-                partial_config = deploy_config
-        except Exception as e:
-            console.error(str(e))
-            return typer.Exit()
+        partial_config = deploy_config or DeployConfigParams()
 
         # Override any local config values from passed CLI arguments
         partial_config.agent_name = agent_name or partial_config.agent_name
@@ -299,13 +327,14 @@ def create_deploy_command(app: typer.Typer):
         partial_config.image_credentials = credentials or partial_config.image_credentials
         partial_config.secret_set = secret_set or partial_config.secret_set
         partial_config.scaling = ScalingParams(
-            min_instances=min_instances
-            if min_instances is not None
-            else partial_config.scaling.min_instances,
-            max_instances=max_instances
-            if max_instances is not None
-            else partial_config.scaling.max_instances,
+            min_agents=min_agents
+            if min_agents is not None
+            else partial_config.scaling.min_agents,
+            max_agents=max_agents
+            if max_agents is not None
+            else partial_config.scaling.max_agents,
         )
+        partial_config.enable_krisp = krisp or partial_config.enable_krisp
 
         # Assert agent name and image are provided
         if not partial_config.agent_name:
@@ -320,8 +349,11 @@ def create_deploy_command(app: typer.Typer):
         table = Table(show_header=False, border_style="dim", show_edge=True, show_lines=True)
         table.add_column("Property", style="cyan")
         table.add_column("Value", style="green")
-        table.add_row("Min instances", str(partial_config.scaling.min_instances))
-        table.add_row("Max instances", str(partial_config.scaling.max_instances))
+        table.add_row("Min agents", str(partial_config.scaling.min_agents))
+        if partial_config.scaling.max_agents:
+            table.add_row("Max agents", str(partial_config.scaling.max_agents))
+        else:
+            table.add_row("Max agents", "[dim]Use existing or default[/dim]")
 
         content = Group(
             (f"[bold white]Agent name:[/bold white] [green]{partial_config.agent_name}[/green]"),
@@ -329,17 +361,18 @@ def create_deploy_command(app: typer.Typer):
             (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]Krisp:[/bold white] {'[dim]Disabled[/dim]' if not partial_config.enable_krisp else '[green]Enabled[/green]'}"),
             "\n[dim]Scaling configuration:[/dim]",
             table,
             *
             (
                 [
                     Text(
-                        f"Note: Usage costs will apply for {partial_config.scaling.min_instances} reserved instance(s). Please see: https://www.daily.co/pricing/pipecat-cloud/",
+                        f"Note: Usage costs will apply for {partial_config.scaling.min_agents} reserved agent(s). Please see: https://www.daily.co/pricing/pipecat-cloud/",
                         style="red",
-                    )] if partial_config.scaling.min_instances else [
+                    )] if partial_config.scaling.min_agents else [
                     Text(
-                        "Note: Deploying with 0 minimum instances may result in cold starts",
+                        "Note: Deploying with 0 minimum agents may result in cold starts",
                         style="red",
                     )]),
         )

{pipecatcloud-0.1.4 → pipecatcloud-0.1.6/src/pipecatcloud.egg-info}/PKG-INFO

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