pipecatcloud 0.2.0__tar.gz → 0.2.2__tar.gz

{pipecatcloud-0.2.0 → pipecatcloud-0.2.2}/CHANGELOG.md

@@ -5,7 +5,69 @@ All notable changes to **Pipecat Cloud** will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.2.2] - 2025-08-18
+
+### Added
+
+- Added `RunnerArguments` as a fallback type in the event that the Pipecat
+  development runner is not imported.
+
+### Changed
+
+- Updated the `typer` dependency to support a range of versions in order to
+  resolve conflicts with other packages. The new range supported is:
+  `"typer>=0.15.3,<0.17.0"`.
+
+- Relaxed the package requirements for `python-dotenv` and `uvicorn` to make it
+  easier to work with Pipecat Cloud. The new supported versions are:
+
+  - `"python-dotenv>=1.0.1,<2.0.0"`
+  - `"uvicorn>=0.32.0,<1.0.0"`
+
+- Updated all types to inherit from `RunnerArguments` to align the types with
+  the Pipecat development runner types. This adds types:
+
+  - `handle_sigint`
+  - `handle_sigterm`
+  - `pipeline_idle_timeout_secs`
+
+### Fixed
+
+- Fixed `ZeroDivisionError` in `agent sessions` command when calculating
+  metrics for agents with zero sessions.
+
+- Fixed `UnboundLocalError` in `agent sessions` command where
+  `metric_renderables` was referenced before assignment due to earlier logic
+  failures.
+
+- `agent sessions` command previously threw `AttributeError` when no agent name
+  was provided via command line or `pcc-deploy.toml`, it now exits gracefully
+  with a clear error message.
+
+## [0.2.1] - 2025-08-02
+
+### Added
+
+- Added a `pipecatcloud[pipecat]` extra for installing `pipecat-ai` dependency.
+
+### Changed
+
+- Session argument types now inherit from pipecat-ai runner types when available.
+  `DailySessionArguments` and `WebSocketSessionArguments` now inherit from
+  `pipecat.runner.types` when `pipecat-ai>=0.0.77` is installed to provide
+  compatibility with the pipecat-ai development runner.
+
+- Add clarifying information to the `pcc secrets image-pull-secret` setup.
+
+- Modified the `aiohttp` minimum version to `3.11.12` and expanded `fastapi` to
+  `>=0.115.6,<0.117.0` in order to align with `pipecat-ai`.
+
+### Deprecated
+
+- When `pipecat-ai` is not installed, session arguments fall back to standalone
+  implementations. This fallback behavior is deprecated and will be removed in
+  a future version. Install with `pip install pipecatcloud[pipecat]` for the
+  preferred implementation.
 
 ## [0.2.0] - 2025-07-09
 

{pipecatcloud-0.2.0/src/pipecatcloud.egg-info → pipecatcloud-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pipecatcloud
-Version: 0.2.0
+Version: 0.2.2
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/
@@ -8,15 +8,17 @@ Keywords: pipecat,pipecat-ai,voice,ai,llm
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp<4.0.0,~=3.11.13
-Requires-Dist: fastapi~=0.115.6
+Requires-Dist: aiohttp<4.0.0,>=3.11.12
+Requires-Dist: fastapi<0.117.0,>=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.15.3
+Requires-Dist: python-dotenv<2.0.0,>=1.0.1
+Requires-Dist: uvicorn<1.0.0,>=0.32.0
+Requires-Dist: typer<0.17.0,>=0.15.3
 Requires-Dist: synchronicity~=0.7.6
 Requires-Dist: toml~=0.10.2
 Requires-Dist: questionary~=2.1.0
+Provides-Extra: pipecat
+Requires-Dist: pipecat-ai>=0.0.79; extra == "pipecat"
 Dynamic: license-file
 
 <h1><div align="center">

pipecatcloud-0.2.2/dev-requirements.txt

@@ -0,0 +1,8 @@
+build~=1.2.2
+grpcio-tools~=1.67.1
+pip-tools~=7.4.1
+pyright~=1.1.402
+pytest~=8.4.1
+ruff~=0.12.1
+setuptools~=78.1.1
+setuptools_scm~=8.3.1

{pipecatcloud-0.2.0 → pipecatcloud-0.2.2}/pyproject.toml

@@ -4,24 +4,27 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pipecatcloud"
-version = "0.2.0"
+version = "0.2.2"
 requires-python = ">=3.10"
 description = "Cloud hosting for Pipecat AI applications"
 license = { text = "BSD 2-Clause License" }
 readme = "README.md"
 keywords = ["pipecat", "pipecat-ai", "voice", "ai", "llm"]
 dependencies = [
-    "aiohttp~=3.11.13,<4.0.0",
-    "fastapi~=0.115.6",
+    "aiohttp>=3.11.12,<4.0.0",
+    "fastapi>=0.115.6,<0.117.0",
     "loguru~=0.7.3",
-    "python-dotenv~=1.0.1",
-    "uvicorn~=0.32.0",
-    "typer~=0.15.3",
+    "python-dotenv>=1.0.1,<2.0.0",
+    "uvicorn>=0.32.0,<1.0.0",
+    "typer>=0.15.3,<0.17.0",
     "synchronicity~=0.7.6",
     "toml~=0.10.2",
     "questionary~=2.1.0"
 ]
 
+[project.optional-dependencies]
+pipecat = ["pipecat-ai>=0.0.79"]
+
 [project.scripts]
 pcc = "pipecatcloud.__main__:main"
 pipecatcloud = "pipecatcloud.__main__:main"

pipecatcloud-0.2.2/pytest.ini

@@ -0,0 +1,14 @@
+[tool:pytest]
+# Basic pytest configuration
+
+testpaths = tests
+python_files = test_*.py
+# Modern import mode for better import control with src/ layout
+addopts = --import-mode=importlib
+
+# Async support for CLI command tests
+asyncio_mode = auto
+
+# Markers actually used in tests
+markers =
+    asyncio: mark test as async test

pipecatcloud-0.2.2/src/pipecatcloud/agent.py

@@ -0,0 +1,133 @@
+#
+# Copyright (c) 2025, Daily
+#
+# SPDX-License-Identifier: BSD 2-Clause License
+#
+
+import warnings
+from dataclasses import dataclass
+from typing import Any, Optional
+
+from fastapi import WebSocket
+
+# Try to import new types from pipecat-ai
+try:
+    from pipecat.runner.types import (
+        DailyRunnerArguments,
+        RunnerArguments,
+        WebSocketRunnerArguments,
+    )
+
+    _PIPECAT_RUNNER_TYPES_AVAILABLE = True
+except ImportError:
+    _PIPECAT_RUNNER_TYPES_AVAILABLE = False
+
+    # Fallback definitions
+    @dataclass
+    class RunnerArguments:
+        """Base class for runner session arguments.
+
+        .. deprecated:: 0.2.2
+            Install pipecatcloud[pipecat] for better compatibility. This class
+            will be removed in a future release.
+        """
+
+        handle_sigint: bool
+        handle_sigterm: bool
+        pipeline_idle_timeout_secs: int
+
+        def __post_init__(self):
+            self.handle_sigint = False
+            self.handle_sigterm = False
+            self.pipeline_idle_timeout_secs = 300
+
+    @dataclass
+    class DailyRunnerArguments(RunnerArguments):
+        """Fallback Daily runner arguments when pipecat-ai not available.
+
+        .. deprecated:: 0.2.1
+            Install pipecatcloud[pipecat] for better compatibility.
+        """
+
+        room_url: str
+        token: str
+        body: Any
+
+    @dataclass
+    class WebSocketRunnerArguments(RunnerArguments):
+        """Fallback WebSocket runner arguments when pipecat-ai not available.
+
+        .. deprecated:: 0.2.1
+            Install pipecatcloud[pipecat] for better compatibility.
+        """
+
+        websocket: WebSocket
+
+
+def _warn_standalone_usage():
+    """Warn users about standalone session arguments usage."""
+    if not _PIPECAT_RUNNER_TYPES_AVAILABLE:
+        warnings.warn(
+            "Using standalone pipecatcloud session arguments without pipecat-ai. "
+            "For better compatibility, install: pip install pipecatcloud[pipecat]. "
+            "Standalone mode will be removed in a future release.",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+
+
+@dataclass
+class SessionArguments:
+    """Base class for common agent session arguments.
+
+    The arguments are received by the bot() entry point.
+
+    Parameters:
+        session_id (Optional[str]): The unique identifier for the session.
+            This is used to track the session across requests.
+    """
+
+    session_id: Optional[str]
+
+
+@dataclass
+class PipecatSessionArguments(RunnerArguments, SessionArguments):
+    """Standard Pipecat Cloud agent session arguments.
+
+    Inherits from RunnerArguments for compatibility with pipecat-ai runner.
+    When pipecat-ai is not installed, uses a fallback implementation (deprecated).
+
+    For best compatibility, install: pip install pipecatcloud[pipecat]
+    """
+
+    body: Any
+
+
+@dataclass
+class DailySessionArguments(DailyRunnerArguments, SessionArguments):
+    """Daily based agent session arguments.
+
+    Inherits from DailyRunnerArguments for compatibility with pipecat-ai runner.
+    When pipecat-ai is not installed, uses a fallback implementation (deprecated).
+
+    For best compatibility, install: pip install pipecatcloud[pipecat]
+    """
+
+    def __post_init__(self):
+        DailyRunnerArguments.__post_init__(self)
+        _warn_standalone_usage()
+
+
+@dataclass
+class WebSocketSessionArguments(WebSocketRunnerArguments, SessionArguments):
+    """WebSocket based agent session arguments.
+
+    Inherits from WebSocketRunnerArguments for compatibility with pipecat-ai runner.
+    When pipecat-ai is not installed, uses a fallback implementation (deprecated).
+
+    For best compatibility, install: pip install pipecatcloud[pipecat]
+    """
+
+    def __post_init__(self):
+        WebSocketRunnerArguments.__post_init__(self)
+        _warn_standalone_usage()

{pipecatcloud-0.2.0 → pipecatcloud-0.2.2}/src/pipecatcloud/cli/commands/agent.py

@@ -220,7 +220,14 @@ async def sessions(
     ),
 ):
     org = organization or config.get("org")
-    agent_name = agent_name or deploy_config.agent_name
+    
+    # Get agent name from argument or deploy config
+    if not agent_name:
+        if deploy_config and deploy_config.agent_name:
+            agent_name = deploy_config.agent_name
+        else:
+            console.error("No target agent name provided")
+            return typer.Exit(1)
 
     with Live(
         console.status(f"[dim]Looking up agent with name '{agent_name}'[/dim]", spinner="dots")
@@ -257,9 +264,10 @@ async def sessions(
         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
+        metric_renderables = []  # Initialize to empty list for type consistency
 
         if duration_metrics and bot_start_metrics and total_sessions > 0:
+            cold_start_percent = cold_starts_count / total_sessions * 100
             metric_renderables = [
                 Panel(
                     f"[bold]Total Sessions:[/bold]\n{total_sessions}\n ",
@@ -289,6 +297,11 @@ async def sessions(
         table.add_column("Cold Start")
 
         for session in data.get("sessions", []):
+            # Note: session["sessionId"] is accessed without defensive checks.
+            # If the API returns malformed data missing sessionId, the CLI will crash with
+            # a KeyError rather than silently skip sessions. This ensures smoke tests and
+            # API verification catch breaking changes immediately. We could instead use
+            # console.error() and skip the session but its unclear if thats better..
             if session_id and session["sessionId"] != session_id:
                 continue
 

{pipecatcloud-0.2.0 → pipecatcloud-0.2.2}/src/pipecatcloud/cli/commands/secrets.py

@@ -471,8 +471,14 @@ async def image_pull_secret(
         return typer.Exit(1)
 
     if not credentials:
+        console.print(
+            "[cyan]For more information about image pull secrets, see: "
+            "https://docs.pipecat.daily.co/agents/secrets#image-pull-secrets[/cyan]\n"
+        )
         username = await questionary.text(f"Username for image repository '{host}'").ask_async()
-        password = await questionary.password(f"Password for image repository '{host}'").ask_async()
+        password = await questionary.password(
+            f"Access token for image repository '{host}'"
+        ).ask_async()
         if not username or not password:
             console.print("[bold red]Image pull secret creation cancelled[/bold red]")
             return typer.Exit(1)

{pipecatcloud-0.2.0 → pipecatcloud-0.2.2/src/pipecatcloud.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pipecatcloud
-Version: 0.2.0
+Version: 0.2.2
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/
@@ -8,15 +8,17 @@ Keywords: pipecat,pipecat-ai,voice,ai,llm
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp<4.0.0,~=3.11.13
-Requires-Dist: fastapi~=0.115.6
+Requires-Dist: aiohttp<4.0.0,>=3.11.12
+Requires-Dist: fastapi<0.117.0,>=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.15.3
+Requires-Dist: python-dotenv<2.0.0,>=1.0.1
+Requires-Dist: uvicorn<1.0.0,>=0.32.0
+Requires-Dist: typer<0.17.0,>=0.15.3
 Requires-Dist: synchronicity~=0.7.6
 Requires-Dist: toml~=0.10.2
 Requires-Dist: questionary~=2.1.0
+Provides-Extra: pipecat
+Requires-Dist: pipecat-ai>=0.0.79; extra == "pipecat"
 Dynamic: license-file
 
 <h1><div align="center">

{pipecatcloud-0.2.0 → pipecatcloud-0.2.2}/src/pipecatcloud.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ README.md
 dev-requirements.txt
 pipecat-cloud.png
 pyproject.toml
+pytest.ini
 .github/workflows/publish-pypi.yml
 .github/workflows/publish-test.yml
 .github/workflows/python-publish.yml
@@ -40,4 +41,6 @@ src/pipecatcloud/cli/commands/deploy.py
 src/pipecatcloud/cli/commands/init.py
 src/pipecatcloud/cli/commands/organizations.py
 src/pipecatcloud/cli/commands/run.py
-src/pipecatcloud/cli/commands/secrets.py
+src/pipecatcloud/cli/commands/secrets.py
+tests/__init__.py
+tests/test_agent_sessions.py

pipecatcloud-0.2.2/src/pipecatcloud.egg-info/requires.txt

@@ -0,0 +1,12 @@
+aiohttp<4.0.0,>=3.11.12
+fastapi<0.117.0,>=0.115.6
+loguru~=0.7.3
+python-dotenv<2.0.0,>=1.0.1
+uvicorn<1.0.0,>=0.32.0
+typer<0.17.0,>=0.15.3
+synchronicity~=0.7.6
+toml~=0.10.2
+questionary~=2.1.0
+
+[pipecat]
+pipecat-ai>=0.0.79

pipecatcloud-0.2.2/tests/__init__.py

@@ -0,0 +1 @@
+# Test package for pipecatcloud

pipecatcloud-0.2.2/tests/test_agent_sessions.py

@@ -0,0 +1,70 @@
+"""
+Unit tests for the 'pcc agent sessions' command.
+
+Tests focus on core behaviors and edge cases, not implementation details.
+"""
+
+import pytest
+from unittest.mock import patch
+import typer
+
+# Import the function under test from local source
+from src.pipecatcloud.cli.commands.agent import sessions
+
+# Test constants
+TEST_ORG = "test-org"
+TEST_AGENT = "test-agent"
+
+
+class TestAgentSessionsCommand:
+    """Test the 'pcc agent sessions' command behaviors."""
+
+    @pytest.fixture
+    def mock_api(self):
+        """Mock the underlying API agent_sessions method."""
+        with patch('src.pipecatcloud.cli.commands.agent.API._agent_sessions') as mock_api:
+            yield mock_api
+
+    def test_handles_zero_sessions_without_crash(self, mock_api):
+        """Agent with zero sessions should not cause ZeroDivisionError."""
+        # Arrange: API returns empty sessions list
+        empty_sessions_response = {"sessions": []}
+        mock_api.return_value = empty_sessions_response
+        
+        # Act & Assert: Should complete without ZeroDivisionError
+        sessions(
+            deploy_config=None,
+            agent_name=TEST_AGENT,
+            session_id=None, 
+            organization=TEST_ORG
+        )
+
+    def test_handles_api_error_gracefully(self, mock_api):
+        """API errors should be handled without crashing.""" 
+        # Arrange: _agent_sessions raises exception (API error)
+        mock_api.side_effect = Exception("Agent not found")
+        
+        # Act: Call with API error  
+        result = sessions(
+            deploy_config=None,
+            agent_name="nonexistent-agent",
+            session_id=None,
+            organization=TEST_ORG
+        )
+        
+        # Assert: Should return typer.Exit on error
+        assert isinstance(result, type(typer.Exit()))
+
+    def test_handles_missing_agent_name_gracefully(self):
+        """Command should exit gracefully when no agent name is provided."""
+        # Act: Call with no agent name from either source
+        result = sessions(
+            deploy_config=None,  # No deploy config
+            agent_name=None,     # No agent name argument
+            session_id=None,
+            organization=TEST_ORG
+        )
+        
+        # Assert: Should return typer.Exit(1) with error message
+        assert isinstance(result, type(typer.Exit()))
+        assert result.exit_code == 1

pipecatcloud-0.2.0/dev-requirements.txt

@@ -1,8 +0,0 @@
-build~=1.2.1
-grpcio-tools~=1.62.2
-pip-tools~=7.4.1
-pyright~=1.1.376
-pytest~=8.3.2
-ruff~=0.6.7
-setuptools~=72.2.0
-setuptools_scm~=8.1.0

pipecatcloud-0.2.0/src/pipecatcloud/agent.py

@@ -1,52 +0,0 @@
-#
-# Copyright (c) 2025, Daily
-#
-# SPDX-License-Identifier: BSD 2-Clause License
-#
-
-from dataclasses import dataclass
-from typing import Any, Optional
-
-from fastapi import WebSocket
-
-
-@dataclass
-class SessionArguments:
-    """Base class for common agent session arguments. The arguments are received
-    by the bot() entry point.
-
-    """
-
-    session_id: Optional[str]
-
-
-@dataclass
-class PipecatSessionArguments(SessionArguments):
-    """Standard Pipecat Cloud agent session arguments. The arguments are
-    received by the bot() entry point.
-
-    """
-
-    body: Any
-
-
-@dataclass
-class DailySessionArguments(SessionArguments):
-    """Daily based agent session arguments. The arguments are received by the
-    bot() entry point.
-
-    """
-
-    room_url: str
-    token: str
-    body: Any
-
-
-@dataclass
-class WebSocketSessionArguments(SessionArguments):
-    """Websocket based agent session arguments. The arguments are received by
-    the bot() entry point.
-
-    """
-
-    websocket: WebSocket

pipecatcloud-0.2.0/src/pipecatcloud.egg-info/requires.txt

@@ -1,9 +0,0 @@
-aiohttp<4.0.0,~=3.11.13
-fastapi~=0.115.6
-loguru~=0.7.3
-python-dotenv~=1.0.1
-uvicorn~=0.32.0
-typer~=0.15.3
-synchronicity~=0.7.6
-toml~=0.10.2
-questionary~=2.1.0