pipecatcloud 0.1.6__tar.gz → 0.1.8__tar.gz

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

@@ -7,28 +7,47 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.8] - 2025-07-09
+
+### Changed
+
+- `deploy` command now shows a warning when image pull credentials are not provided.
+
+### Added
+
+- Add py.typed marker for static type checking support.
+
+## [0.1.7] - 2025-06-12
+
+### Added
+
+- `agent sessions` command lists session history and various statistics (avg. start times, cold starts etc.)
+
+### Fixed
+
+- Bumped `typer` dependency to `0.15` to fix errors when using `--help` flag.
+
 ## [0.1.6] - 2025-04-25
 
-# Changed
+### Changed
 
 - `min-instances` and `max-instances` has been changed to reflect API terminology changes.
 
 ## [0.1.5] - 2025-04-09
 
-# Added
+### Added
 
 - `deploy` command now accepts a `--enable-krisp / -krisp` which enables Krisp integration for your pipeline.
 
-# Changed
+### Changed
 
-- `start` command now takes agent name from `pcc-deploy.toml` where applicable 
+- `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
+### Fixed
 
 - REST and cURL requests now render errors correctly
 
-
 ## [0.1.4] - 2025-03-28
 
 ### Changed
@@ -53,8 +72,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- `agent logs` now accepts a `--deployment_id` / `-d` argument for filtering 
-by specific deployment ID
+- `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`.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pipecatcloud
-Version: 0.1.6
+Version: 0.1.8
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/
@@ -13,7 +13,7 @@ Requires-Dist: fastapi~=0.115.6
 Requires-Dist: loguru~=0.7.3
 Requires-Dist: python-dotenv~=1.0.1
 Requires-Dist: uvicorn~=0.32.0
-Requires-Dist: typer~=0.13.0
+Requires-Dist: typer~=0.15.3
 Requires-Dist: synchronicity~=0.7.6
 Requires-Dist: toml~=0.10.2
 Requires-Dist: questionary~=2.1.0

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pipecatcloud"
-version = "0.1.6"
+version = "0.1.8"
 requires-python = ">=3.10"
 description = "Cloud hosting for Pipecat AI applications"
 license = { text = "BSD 2-Clause License" }
@@ -16,7 +16,7 @@ dependencies = [
     "loguru~=0.7.3",
     "python-dotenv~=1.0.1",
     "uvicorn~=0.32.0",
-    "typer~=0.13.0",
+    "typer~=0.15.3",
     "synchronicity~=0.7.6",
     "toml~=0.10.2",
     "questionary~=2.1.0"
@@ -33,6 +33,9 @@ package-dir = {"" = "src"}
 where = ["src"]
 include = ["pipecatcloud*"]
 
+[tool.setuptools.package-data]
+pipecatcloud = ["py.typed"]
+
 [tool.ruff]
 exclude = ["*_pb2.py"]
 line-length = 100

{pipecatcloud-0.1.6 → pipecatcloud-0.1.8}/src/pipecatcloud/_utils/console_utils.py

@@ -4,6 +4,8 @@
 # SPDX-License-Identifier: BSD 2-Clause License
 #
 
+import statistics
+from datetime import datetime
 from typing import Optional, Union
 
 from rich.console import Console
@@ -140,3 +142,95 @@ def format_timestamp(timestamp: str) -> str:
 
     # Return original if parsing fails
     return timestamp
+
+
+def format_duration(created_at_str: str, ended_at_str: str) -> str | None:
+    """Calculate and format session duration as HH:MM:SS"""
+    if not ended_at_str:
+        return None
+
+    try:
+        created_at = datetime.fromisoformat(created_at_str.replace('Z', '+00:00'))
+        ended_at = datetime.fromisoformat(ended_at_str.replace('Z', '+00:00'))
+        duration = ended_at - created_at
+
+        # Convert to total seconds
+        total_seconds = int(duration.total_seconds())
+
+        # Calculate hours, minutes, seconds
+        hours = total_seconds // 3600
+        minutes = (total_seconds % 3600) // 60
+        seconds = total_seconds % 60
+
+        return f"{hours:02d}:{minutes:02d}:{seconds:02d}"
+    except Exception:
+        return None
+
+
+def calculate_percentiles(data: list[float]) -> tuple[float, float, float] | None:
+    """
+    Calculate average, 5th percentile, and 95th percentile for a list of numeric data.
+
+    Args:
+        data: List of float values to analyze
+
+    Returns:
+        Tuple of (average, p5, p95) if data is provided, None if empty list.
+        For single values, p5 and p95 will equal the single value.
+    """
+    if not data:
+        return None
+
+    avg = statistics.mean(data)
+
+    if len(data) == 1:
+        return avg, data[0], data[0]
+
+    sorted_data = sorted(data)
+
+    def percentile(data_list, p):
+        if not data_list:
+            return 0
+        k = (len(data_list) - 1) * p / 100
+        f = int(k)
+        c = k - f
+        if f + 1 < len(data_list):
+            return data_list[f] * (1 - c) + data_list[f + 1] * c
+        else:
+            return data_list[f]
+
+    p5 = percentile(sorted_data, 5)
+    p95 = percentile(sorted_data, 95)
+
+    return avg, p5, p95
+
+
+async def cli_updates_available() -> str | None:
+    """
+    Check if there are updates available for the CLI from PyPI.
+    """
+    import aiohttp
+
+    try:
+        from importlib.metadata import version as get_version
+        current_version = get_version("pipecatcloud")
+    except ImportError:
+        return None
+
+    pypi_url = "https://pypi.org/pypi/pipecatcloud/json"
+
+    try:
+        async with aiohttp.ClientSession() as session:
+            response = await session.get(pypi_url)
+            if not response.ok:
+                return None
+
+            data = await response.json()
+            latest_version = data["info"]["version"]
+
+            if latest_version > current_version:
+                return latest_version
+            return None
+
+    except Exception:
+        return None

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

@@ -428,3 +428,11 @@ class _API:
     @property
     def agent_logs(self):
         return self.create_api_method(self._agent_logs)
+
+    async def _agent_sessions(self, agent_name: str, org: str) -> dict | None:
+        url = f"{self.construct_api_url('services_sessions_path').format(org=org, service=agent_name)}"
+        return await self._base_request("GET", url) or {}
+
+    @property
+    def agent_sessions(self):
+        return self.create_api_method(self._agent_sessions)

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

@@ -5,6 +5,7 @@
 #
 
 import json
+import statistics
 from enum import Enum
 
 import aiohttp
@@ -21,7 +22,7 @@ from rich.text import Text
 
 from pipecatcloud._utils.async_utils import synchronizer
 from pipecatcloud._utils.auth_utils import requires_login
-from pipecatcloud._utils.console_utils import console, format_timestamp
+from pipecatcloud._utils.console_utils import console, format_duration, format_timestamp, calculate_percentiles
 from pipecatcloud.cli import PIPECAT_CLI_NAME
 from pipecatcloud.cli.api import API
 from pipecatcloud.cli.config import config
@@ -200,18 +201,31 @@ async def status(
 @agent_cli.command(name="sessions", help="List active sessions for an agent")
 @synchronizer.create_blocking
 @requires_login
+@with_deploy_config
 async def sessions(
-    agent_name: str,
+    deploy_config=typer.Option(None, hidden=True),
+    agent_name: str = typer.Argument(
+        None,
+        help="Name of the agent to list sessions for e.g. 'my-agent'",
+        show_default=False
+    ),
+    session_id: str = typer.Option(
+        None,
+        "--id",
+        "-i",
+        help="Session ID to filter by",
+    ),
     organization: str = typer.Option(
         None, "--organization", "-o", help="Organization to list sessions for"
     ),
 ):
     org = organization or config.get("org")
+    agent_name = agent_name or deploy_config.agent_name
 
     with Live(
         console.status(f"[dim]Looking up agent with name '{agent_name}'[/dim]", spinner="dots")
     ) as live:
-        data, error = await API.agent(agent_name=agent_name, org=org, live=live)
+        data, error = await API.agent_sessions(agent_name=agent_name, org=org, live=live)
 
         live.stop()
 
@@ -219,24 +233,104 @@ async def sessions(
             return typer.Exit()
 
         if not data:
-            console.error(f"No deployment data found for agent with name '{agent_name}'")
+            console.error(f"No session data found for agent with name '{agent_name}'")
             return typer.Exit()
 
-        console.print(
-            "[yellow]Please note: this method is currently work in progress and will be updated in the future with more information[/yellow]"
-        )
+        sessions_list = data.get("sessions", [])
+        total_sessions = len(sessions_list)
 
-        if data.get("activeSessionCount", 0) > 0:
-            console.success(
-                f"{data.get('activeSessionCount', 0)}",
-                title=f"Active session count for agent {agent_name} [dim]({org})[/dim]",
-            )
-        else:
-            console.error(
-                f"No active sessions found for agent {agent_name}",
-                title=f"Active session count for agent {agent_name} [dim]({org})[/dim]",
-                subtitle=f"[white dim]Start a new session with[/white dim] [bold cyan]{PIPECAT_CLI_NAME} agent start {agent_name}[/bold cyan]",
-            )
+        completed_sessions = [s for s in sessions_list if s.get("endedAt")]
+
+        durations = []
+        for session in completed_sessions:
+            try:
+                from datetime import datetime
+                created_at = datetime.fromisoformat(session["createdAt"].replace('Z', '+00:00'))
+                ended_at = datetime.fromisoformat(session["endedAt"].replace('Z', '+00:00'))
+                duration_seconds = (ended_at - created_at).total_seconds()
+                durations.append(duration_seconds)
+            except BaseException:
+                continue
+
+        bot_start_times = [s["botStartSeconds"]
+                           for s in sessions_list if s.get("botStartSeconds") is not None]
+        bot_start_metrics = calculate_percentiles(bot_start_times)
+        duration_metrics = calculate_percentiles(durations)
+        cold_starts_count = sum(1 for s in sessions_list if s.get("coldStart") is True)
+        cold_start_percent = cold_starts_count / total_sessions * 100
+
+        if duration_metrics and bot_start_metrics and total_sessions > 0:
+            metric_renderables = [
+                Panel(
+                    f"[bold]Total Sessions:[/bold]\n{total_sessions}\n ",
+                    expand=True,
+                ),
+                Panel(
+                    f"[bold]Average Duration:[/bold]\n{duration_metrics[0]:.1f}s\n[dim](p5: {duration_metrics[1]:.1f}s, p95: {duration_metrics[2]:.1f}s)[/dim]",
+                    expand=True,
+                ),
+                Panel(
+                    f"[bold]Bot Start Time:[/bold]\n{bot_start_metrics[0]:.1f}s\n[dim](p5: {bot_start_metrics[1]:.1f}s, p95: {bot_start_metrics[2]:.1f}s)[/dim]",
+                    expand=True,
+                ),
+                Panel(
+                    f"[bold]Cold Starts:[/bold]\n{cold_starts_count}/{total_sessions}\n[dim]({cold_start_percent:.1f}%)[/dim]",
+                    expand=True,
+                ),
+            ]
+
+        table = Table(show_header=True, show_lines=True, border_style="dim", box=box.SIMPLE)
+        table.add_column("Session ID")
+        table.add_column("Created At")
+        table.add_column("Ended At")
+        table.add_column("Duration")
+        table.add_column("Status")
+        table.add_column("Bot Start Time")
+        table.add_column("Cold Start")
+
+        for session in data.get("sessions", []):
+            if session_id and session["sessionId"] != session_id:
+                continue
+
+            session_duration = format_duration(
+                session["createdAt"], session["endedAt"]) or "[dim]N/A[/dim]"
+            status = session.get("completionStatus", "")
+            if session["endedAt"]:
+                if status == "500":
+                    status_display = "[red]Error (500)[/red]"
+                else:
+                    status_display = "Complete"
+            else:
+                status_display = "[yellow]Active[/yellow]"
+
+            is_cold_start = session["coldStart"] is True
+            row_style = "on red" if is_cold_start else ""
+
+            row_data = [
+                session["sessionId"],
+                format_timestamp(
+                    session["createdAt"]),
+                format_timestamp(
+                    session["endedAt"]) if session["endedAt"] else "[dim]N/A[/dim]",
+                session_duration,
+                status_display,
+                f"{session['botStartSeconds']}s" if session["botStartSeconds"] is not None else "[dim]N/A[/dim]",
+                "[red]Yes[/red]" if session["coldStart"] is True else "No" if session["coldStart"] is False else "[dim]N/A[/dim]",
+            ]
+
+            if is_cold_start:
+                row_data = [f"[{row_style}]{cell}[/]" for cell in row_data]
+
+            table.add_row(*row_data)
+
+        console.success(
+            Group(
+                Columns(
+                    metric_renderables,
+                    equal=True) if metric_renderables and not session_id else "",
+                table),
+            title=f"Session data for agent {agent_name} [dim]({org})[/dim]",
+        )
 
 
 @agent_cli.command(name="scale", help="Modify agent runtime configuration")

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

@@ -232,6 +232,14 @@ def create_deploy_command(app: typer.Typer):
         image: str = typer.Argument(
             None, help="Docker image location e.g. 'my-image:latest'", show_default=False
         ),
+        credentials: str = typer.Option(
+            None,
+            "--credentials",
+            "-c",
+            help="Image pull secret to use for deployment",
+            rich_help_panel="Deployment Configuration",
+            show_default=False,
+        ),
         min_agents: int = typer.Option(
             None,
             "--min-agents",
@@ -263,13 +271,7 @@ def create_deploy_command(app: typer.Typer):
             help="Organization to deploy to",
             rich_help_panel="Deployment Configuration",
         ),
-        credentials: str = typer.Option(
-            None,
-            "--credentials",
-            "-c",
-            help="Image pull secret to use for deployment",
-            rich_help_panel="Deployment Configuration",
-        ),
+
         krisp: bool = typer.Option(
             False,
             "--enable-krisp",
@@ -282,6 +284,7 @@ def create_deploy_command(app: typer.Typer):
             "--force",
             "-f",
             help="Force deployment / skip confirmation",
+            rich_help_panel="Additional Options",
         ),
         # @deprecated
         min_instances: int = typer.Option(
@@ -345,6 +348,25 @@ def create_deploy_command(app: typer.Typer):
             console.error("Image / repository URL is required")
             return typer.Exit()
 
+        # Show a warning if no credentials are provided
+        if not partial_config.image_credentials and not skip_confirm:
+            console.print(
+                Panel(
+                    "[yellow]You are attempting to deploy an agent image without an image pull secret."
+                    "\n\nUse [bold][--credentials][/bold] to provide a image pull secret."
+                    "\n\nPlease be aware that future versions of the Pipecat Cloud CLI will require credentials for all deployments (unless forced manually).",
+                    title="[bold yellow]Warning: Deploying without credentials[/bold yellow]",
+                    title_align="left",
+                    subtitle_align="left",
+                    subtitle="[dim]Learn more: https://docs.pipecat.daily.co/agents/secrets#image-pull-secrets[/dim]",
+                    border_style="yellow",
+                ))
+            if not typer.confirm(
+                "Are you sure you want to deploy without an image pull secret?",
+                default=False,
+            ):
+                return typer.Exit()
+
         # Create and display table
         table = Table(show_header=False, border_style="dim", show_edge=True, show_lines=True)
         table.add_column("Property", style="cyan")

{pipecatcloud-0.1.6 → pipecatcloud-0.1.8}/src/pipecatcloud/config.py

@@ -30,6 +30,7 @@ _SETTINGS = {
     "services_path": _Setting("/v1/organizations/{org}/services"),
     "services_logs_path": _Setting("/v1/organizations/{org}/services/{service}/logs"),
     "services_deployments_path": _Setting("/v1/organizations/{org}/services/{service}/deployments"),
+    "services_sessions_path": _Setting("/v1/organizations/{org}/services/{service}/sessions"),
     "start_path": _Setting("/v1/public/{service}/start"),
     "api_keys_path": _Setting("/v1/organizations/{org}/apiKeys"),
     "secrets_path": _Setting("/v1/organizations/{org}/secrets"),

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pipecatcloud
-Version: 0.1.6
+Version: 0.1.8
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/
@@ -13,7 +13,7 @@ Requires-Dist: fastapi~=0.115.6
 Requires-Dist: loguru~=0.7.3
 Requires-Dist: python-dotenv~=1.0.1
 Requires-Dist: uvicorn~=0.32.0
-Requires-Dist: typer~=0.13.0
+Requires-Dist: typer~=0.15.3
 Requires-Dist: synchronicity~=0.7.6
 Requires-Dist: toml~=0.10.2
 Requires-Dist: questionary~=2.1.0

{pipecatcloud-0.1.6 → pipecatcloud-0.1.8}/src/pipecatcloud.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ src/pipecatcloud/agent.py
 src/pipecatcloud/api.py
 src/pipecatcloud/config.py
 src/pipecatcloud/exception.py
+src/pipecatcloud/py.typed
 src/pipecatcloud/session.py
 src/pipecatcloud.egg-info/PKG-INFO
 src/pipecatcloud.egg-info/SOURCES.txt

{pipecatcloud-0.1.6 → pipecatcloud-0.1.8}/src/pipecatcloud.egg-info/requires.txt

@@ -3,7 +3,7 @@ fastapi~=0.115.6
 loguru~=0.7.3
 python-dotenv~=1.0.1
 uvicorn~=0.32.0
-typer~=0.13.0
+typer~=0.15.3
 synchronicity~=0.7.6
 toml~=0.10.2
 questionary~=2.1.0