pipecatcloud 0.1.0__tar.gz → 0.1.2__tar.gz

{pipecatcloud-0.1.0 → pipecatcloud-0.1.2}/.github/workflows/publish-pypi.yml

@@ -45,12 +45,19 @@ jobs:
       - name: Build package
         run: python -m build
 
-      - name: Create release tag
+      - name: Check and create release tag if needed
         run: |
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Action"
-          git tag -a "v${{ github.event.inputs.version }}" -m "Version ${{ github.event.inputs.version }}"
-          git push origin "v${{ github.event.inputs.version }}"
+          
+          # Check if tag already exists remotely
+          if git ls-remote --tags origin | grep -q "refs/tags/v${{ github.event.inputs.version }}"; then
+            echo "Tag v${{ github.event.inputs.version }} already exists, skipping tag creation"
+          else
+            echo "Creating new tag v${{ github.event.inputs.version }}"
+            git tag -a "v${{ github.event.inputs.version }}" -m "Version ${{ github.event.inputs.version }}"
+            git push origin "v${{ github.event.inputs.version }}"
+          fi
 
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

{pipecatcloud-0.1.0 → pipecatcloud-0.1.2}/.github/workflows/publish-test.yml

@@ -15,8 +15,8 @@ jobs:
       name: pypi
       url: https://test.pypi.org/project/pipecat-cloud
     permissions:
-      id-token: write # IMPORTANT: this permission is needed for trusted publishing
-      contents: write # Needed for tagging
+      id-token: write 
+      contents: write
 
     steps:
       - name: Checkout code
@@ -45,15 +45,23 @@ jobs:
       - name: Build package
         run: python -m build
 
-      - name: Create release tag
+      - name: Check and create release tag if needed
         run: |
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Action"
-          git tag -a "v${{ github.event.inputs.version }}" -m "Version ${{ github.event.inputs.version }}"
-          git push origin "v${{ github.event.inputs.version }}"
+          
+          # Check if tag already exists remotely
+          if git ls-remote --tags origin | grep -q "refs/tags/v${{ github.event.inputs.version }}"; then
+            echo "Tag v${{ github.event.inputs.version }} already exists, skipping tag creation"
+          else
+            echo "Creating new tag v${{ github.event.inputs.version }}"
+            git tag -a "v${{ github.event.inputs.version }}" -m "Version ${{ github.event.inputs.version }}"
+            git push origin "v${{ github.event.inputs.version }}"
+          fi
 
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
+          repository-url: https://test.pypi.org/legacy/
           verbose: true
-          print-hash: true
+          print-hash: true

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

@@ -5,13 +5,35 @@ 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.1.2] - 2025-03-12
+
+### Added
+
+- `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
+
+### Changed
+
+- Change the of deploy checks from 30 to 18, reducing the overall time for a
+  deployment.
+
+- Added a `--format / -f` option for `agent logs`. Options are `TEXT` and
+  `JSON`.
+
+- Improved error messaging for `ConfigError` to improve debugging.
+
 ## [0.1.0] - 2025-03-05
 
-- `pipecatcloud.toml` moved to `$HOME/.config/pipecatcloud/pipecatcloud.toml`
+- `pipecatcloud.toml` moved to `$HOME/.config/pipecatcloud/pipecatcloud.toml`.
 
 ### Added
 
-- `pcc auth whoami` now shows the namespace Daily API key for convenience
+- `pcc auth whoami` now shows the namespace Daily API key for convenience.
 
 ## [0.0.11] - 2025-03-04
 
@@ -83,4 +105,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed a bug where `pcc-deploy.toml` files were required to be present.
 
 - `deploy` command now correctly passes the secret set to the deployment from
-  the `pcc-deploy.toml` file.
+  the `pcc-deploy.toml` file.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pipecatcloud
-Version: 0.1.0
+Version: 0.1.2
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/
@@ -19,7 +19,7 @@ Requires-Dist: toml~=0.10.2
 Requires-Dist: questionary~=2.1.0
 
 <h1><div align="center">
- <img alt="pipecat cloud" width="500px" height="auto" src="./pipecat-cloud.png">
+ <img alt="pipecat cloud" width="500px" height="auto" src="https://raw.githubusercontent.com/daily-co/pipecat-cloud/main/pipecat-cloud.png">
 </div></h1>
 
 [![Docs](https://img.shields.io/badge/documentation-blue)](https://docs.pipecat.daily.co)

{pipecatcloud-0.1.0 → pipecatcloud-0.1.2}/README.md

@@ -1,5 +1,5 @@
 <h1><div align="center">
- <img alt="pipecat cloud" width="500px" height="auto" src="./pipecat-cloud.png">
+ <img alt="pipecat cloud" width="500px" height="auto" src="https://raw.githubusercontent.com/daily-co/pipecat-cloud/main/pipecat-cloud.png">
 </div></h1>
 
 [![Docs](https://img.shields.io/badge/documentation-blue)](https://docs.pipecat.daily.co)

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

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

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

@@ -9,7 +9,8 @@ import sys
 
 from loguru import logger
 
-from .exception import (
+from pipecatcloud.agent import DailySessionArguments, SessionArguments, WebSocketSessionArguments
+from pipecatcloud.exception import (
     AgentNotHealthyError,
     AgentStartError,
     AuthError,
@@ -18,13 +19,17 @@ from .exception import (
     Error,
     InvalidError,
 )
-from .session import Session, SessionParams
+from pipecatcloud.session import Session, SessionParams
 
 logger.remove()
 logger.add(sys.stderr, level=str(os.getenv("PCC_LOG_LEVEL", "INFO")))
 
 
 __all__ = [
+    # Agent classes
+    "SessionArguments",
+    "DailySessionArguments",
+    "WebSocketSessionArguments",
     # Session classes
     "Session",
     "SessionParams",

pipecatcloud-0.1.2/src/pipecatcloud/agent.py

@@ -0,0 +1,52 @@
+#
+# 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.1.0 → pipecatcloud-0.1.2}/src/pipecatcloud/cli/commands/agent.py

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: BSD 2-Clause License
 #
 
+import json
 from enum import Enum
 
 import aiohttp
@@ -220,6 +221,11 @@ async def scale():
     console.error("Not implemented")
 
 
+class LogFormat(str, Enum):
+    TEXT = "TEXT"
+    JSON = "JSON"
+
+
 class LogLevel(str, Enum):
     DEBUG = "DEBUG"
     INFO = "INFO"
@@ -229,8 +235,8 @@ class LogLevel(str, Enum):
 
 
 class LogLevelColors(str, Enum):
-    DEBUG = "dim white"
-    INFO = "white"
+    DEBUG = "blue"
+    INFO = "green"
     WARNING = "yellow"
     ERROR = "red"
     CRITICAL = "bold red"
@@ -245,6 +251,7 @@ async def logs(
         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"),
 ):
     org = organization or config.get("org")
@@ -271,10 +278,14 @@ async def logs(
             # filter out any messages that do not match our log level
             if level and severity.value != level.value:
                 continue
-            color = getattr(LogLevelColors, severity, LogLevelColors.DEBUG).value
-            console.print(Text(timestamp, style="bold dim"))
-            console.print(Text(l.get("log", ""), style=color))
-            console.rule(style="dim")
+
+            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))
+            elif format == LogFormat.JSON:
+                line = {"timestamp": timestamp, "log": l.get("log", "")}
+                console.print(Text(json.dumps(line, ensure_ascii=False), style="gray"))
 
 
 @agent_cli.command(name="delete", help="Delete an agent.")
@@ -349,7 +360,6 @@ async def deployments(
                 response.raise_for_status()
 
             data = await response.json()
-            print(data)
 
             table = Table(
                 show_header=True,

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

@@ -25,7 +25,7 @@ from pipecatcloud.cli import PIPECAT_CLI_NAME
 from pipecatcloud.cli.api import API
 from pipecatcloud.cli.config import config
 
-MAX_ALIVE_CHECKS = 30
+MAX_ALIVE_CHECKS = 18
 ALIVE_CHECK_SLEEP = 5
 
 # ----- Command
@@ -36,7 +36,8 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
 
     # Check for an existing deployment with this agent name
     with Live(
-        console.status("[dim]Checking for existing agent deployment...[/dim]", spinner="dots"), transient=True
+        console.status("[dim]Checking for existing agent deployment...[/dim]", spinner="dots"),
+        transient=True,
     ) as live:
         data, error = await API.agent(agent_name=params.agent_name, org=org, live=live)
 
@@ -57,7 +58,7 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
                     return typer.Exit()
 
     # Start the deployment process
-    with Live(console.status("[dim]Preparing deployment...", spinner="dots")) as live:
+    with Live(console.status("[dim]Preparing deployment...", spinner="dots"), transient=True) as live:
         """
         # 1. Check that provided secret set exists
         """
@@ -93,7 +94,7 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
             )
 
             if error:
-                if error == 400:
+                if error.get("code") == "400":
                     creds_exist = True
                 else:
                     API.print_error()
@@ -134,9 +135,13 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
     is_ready = False
     checks_performed = 0
 
+    console.print(
+        f"[bold cyan]{'Updating' if existing_agent else 'Pushing'}[/bold cyan] deployment for agent '{params.agent_name}'")
+
     # Create a simple spinner for the polling phase
+    deployment_status_message = "[dim]Waiting for deployment to become ready...[/dim]"
     with console.status(
-        "[dim]Waiting for deployment to become ready...[/dim]", spinner="bouncingBar"
+        deployment_status_message, spinner="bouncingBar"
     ) as status:
         try:
             while checks_performed < MAX_ALIVE_CHECKS:
@@ -153,6 +158,7 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
                 # Update deployment ID if received (silently)
                 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]"
 
                 # Check if deployment is ready
                 if agent_status.get("ready"):
@@ -176,17 +182,37 @@ async def _deploy(params: DeployConfigParams, org, force: bool = False):
         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:
-        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",
-        )
+        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",
+            )
     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()
 
@@ -299,17 +325,24 @@ 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.0 → pipecatcloud-0.1.2}/src/pipecatcloud/cli/config.py

@@ -27,22 +27,26 @@ deploy_config_path: str = os.environ.get("PIPECAT_DEPLOY_CONFIG_PATH") or os.pat
 
 def _read_user_config():
     config_data = {}
+    config_problem = ""
+
     if os.path.exists(user_config_path):
         try:
             with open(user_config_path) as f:
                 config_data = toml.load(f)
+        except toml.TomlDecodeError as exc:
+            config_problem = f"Invalid TOML syntax in config file: {exc}"
+        except PermissionError:
+            config_problem = f"Permission denied when reading config file: {user_config_path}"
+        except IOError as exc:
+            config_problem = f"I/O error when reading config file: {exc}"
         except Exception as exc:
-            config_problem = str(exc)
+            config_problem = f"Error reading config file: {exc}"
         else:
             top_level_keys = {"token", "org"}
             org_sections = {k: v for k, v in config_data.items() if k not in top_level_keys}
 
             if not all(isinstance(e, dict) for e in org_sections.values()):
-                raise ConfigError(
-                    "Pipecat Cloud config file is not valid TOML. Organization sections must be dictionaries. Please log out and log back in."
-                )
-            else:
-                config_problem = ""
+                config_problem = "Pipecat Cloud config file is not valid TOML. Organization sections must be dictionaries. Please log out and log back in."
         if config_problem:
             raise ConfigError(config_problem)
 
@@ -87,8 +91,14 @@ def update_user_config(
 
     try:
         _write_user_config(existing_config)
-    except Exception:
-        raise ConfigError
+    except PermissionError:
+        raise ConfigError(f"Permission denied when writing to {user_config_path}")
+    except FileNotFoundError:
+        raise ConfigError(f"Cannot create configuration directory for {user_config_path}")
+    except IOError as e:
+        raise ConfigError(f"IO error when writing configuration: {str(e)}")
+    except Exception as e:
+        raise ConfigError(f"Unexpected error updating configuration: {str(e)}")
 
 
 # --- Config

{pipecatcloud-0.1.0 → pipecatcloud-0.1.2}/src/pipecatcloud/exception.py

@@ -6,6 +6,8 @@
 
 from typing import Optional, Union
 
+from pipecatcloud.cli import PIPECAT_CLI_NAME
+
 
 class Error(Exception):
     """Base class for exceptions in this module."""
@@ -24,7 +26,7 @@ class AuthError(Error):
 
     def __init__(
         self,
-        message: str = "Unauthorized / token expired. Please run `pcc auth login` to login again.",
+        message: str = f"Unauthorized / token expired. Please run `{PIPECAT_CLI_NAME} auth login` to login again.",
     ):
         self.message = message
         super().__init__(self.message)
@@ -37,6 +39,10 @@ class InvalidError(Error):
 class ConfigError(Error):
     """Raised when config is unable to be stored or updated"""
 
+    def __init__(self, message: str = "Failed to update configuration"):
+        self.message = message
+        super().__init__(self.message)
+
 
 class AgentNotHealthyError(Error):
     """Raised when agent is not healthy and cannot be started."""

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pipecatcloud
-Version: 0.1.0
+Version: 0.1.2
 Summary: Cloud hosting for Pipecat AI applications
 License: BSD 2-Clause License
 Project-URL: Website, https://docs.pipecat.daily.co/
@@ -19,7 +19,7 @@ Requires-Dist: toml~=0.10.2
 Requires-Dist: questionary~=2.1.0
 
 <h1><div align="center">
- <img alt="pipecat cloud" width="500px" height="auto" src="./pipecat-cloud.png">
+ <img alt="pipecat cloud" width="500px" height="auto" src="https://raw.githubusercontent.com/daily-co/pipecat-cloud/main/pipecat-cloud.png">
 </div></h1>
 
 [![Docs](https://img.shields.io/badge/documentation-blue)](https://docs.pipecat.daily.co)

{pipecatcloud-0.1.0 → pipecatcloud-0.1.2}/src/pipecatcloud.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ pyproject.toml
 src/pipecatcloud/__init__.py
 src/pipecatcloud/__main__.py
 src/pipecatcloud/__version__.py
+src/pipecatcloud/agent.py
 src/pipecatcloud/api.py
 src/pipecatcloud/config.py
 src/pipecatcloud/exception.py