pipecatcloud 0.0.6__tar.gz → 0.0.8__tar.gz

{pipecatcloud-0.0.6 → pipecatcloud-0.0.8}/.github/workflows/python-publish.yml

@@ -1,12 +1,4 @@
-# This workflow will upload a Python Package to PyPI when a release is created
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Upload Python Package
+name: Build and publish Python package
 
 on:
   release:
@@ -77,9 +69,8 @@ jobs:
         id: changelog
         run: |
           if [ -f "CHANGELOG.md" ]; then
-            echo "CHANGELOG_CONTENT<<EOF" >> $GITHUB_ENV
-            cat CHANGELOG.md >> $GITHUB_ENV
-            echo "EOF" >> $GITHUB_ENV
+            CHANGELOG_CONTENT=$(cat CHANGELOG.md)
+            echo "CHANGELOG_CONTENT=${CHANGELOG_CONTENT}" >> $GITHUB_ENV
           else
             echo "CHANGELOG_CONTENT=No changelog available." >> $GITHUB_ENV
           fi

{pipecatcloud-0.0.6 → pipecatcloud-0.0.8}/.gitignore

@@ -1,3 +1,5 @@
+pcc-deploy.toml
+
 # Python
 __pycache__/
 *.py[cod]

pipecatcloud-0.0.8/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Pipecat Cloud Changelog
+
+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).
+
+## [0.0.8] - 2025-02-03
+
+### Added
+- `secrets set [set-name] --file` allowing you to create a secret set from .env file
+- `agent scale` to modify agent configuration without pushing a new image
+- `run` command for running bot.py files locally via FastAPI. This initial implementation is very basic and will be expanded in the future.
+- `organizations select` allows passing an `--org / -o` option to bypass prompt
+
+### Fixed
+- All commands use the correct shorthand flag syntax (`-` vs. `--`)
+- CLI config extends from module config to avoid loading config TOML with package imports
+- `secrets list` now correctly lists all secrets vs. just a single entry
+- `deploy` command displays live status to prevent skewed terminal output
+- `deploy` command no longer allows pushing images without a tag
+- `agent logs` paginate / filter / sort and tidy up display for logs
+- `start` command correctly clears the live terminal text
+- `pcc-deploy.toml` files now work as intended with `deploy` command
+- `deploy` method now passes configuration parameters correctly
+- Switching organizations will fully remove any default API tokens from the previously selected organization
+
+### Changed
+- Local config now retains default keys when switching between organizations
+- Local config now retains defaukt keys when logging in again
+- `deploy` will check passed secret set exists before deployment
+- `secrets list` now takes an optional `--sets / -s` parameter that filters by secret sets or image pull secrets
+- `organizations keys create` now prompts you to set the newly created key as the default after creation (if active org matches)
+- `organizations keys delete` not prompts to confirm if selected key is currently your local config default
+- `Agent` module import has been renamed to `Session` to better reflect API
+
+
+## [0.0.7] - 2025-02-01
+
+### Added
+
+- `run` command for running an agent locally. This initial implementation is very basic and will be expanded in the future.
+
+### Changed
+
+- `start_agent` method no longer requires an organization. If not provided, it will assume the namespace of the API token owner.
+- `start` command no longer looks up the agent before starting (health check is handled by the proxy route.)
+
+## [0.0.6] - 2025-02-01
+
+### Added
+
+- `pipecatcloud.agent` module for working with agents via Python scripts
+    - `start_agent` method for starting an agent
+
+### Backlog
+
+- `deploy` make image pull secrets non-optional, but allow for bypassing
+- Fix: update docs to assert that the bot method must be async
+- Fix: Secrets are not upserting (overriding each time, which may be preferrable?)
+- Fix: deployment process needs better output
+- `organizations keys create` should ask if you'd like to set the created key as default after creation (if org matches)
+- Sense check image parameter of the deploy command (does it have a tag, etc)
+- `agent logs` paginate / filter / sort and tidy up display for logs
+- Fix: start command should clear the live text
+- Secrets from .env method
+- Fix: .pcc-deploy.toml should read correctly 
+- New conveience method to add account associated Daily API Key to a secret set
+- Add: concurrency support for agent deployments

{pipecatcloud-0.0.6/src/pipecatcloud.egg-info → pipecatcloud-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pipecatcloud
-Version: 0.0.6
+Version: 0.0.8
 Requires-Python: >=3.10
 Requires-Dist: aiohttp~=3.10.10
 Requires-Dist: fastapi~=0.115.5

{pipecatcloud-0.0.6 → pipecatcloud-0.0.8}/README.md

@@ -5,7 +5,7 @@
 
 
 [![Docs](https://img.shields.io/badge/documentation-blue)](https://docs.pipecat.cloud)
-[![PyPI](https://img.shields.io/pypi/v/pipecat-cloud)](https://pypi.org/project/pipecat-cloud)
+[![PyPI](https://img.shields.io/pypi/v/pipecatcloud)](https://pypi.org/project/pipecatcloud)
 
 # Pipecat Cloud
 
@@ -27,10 +27,11 @@ Documentation for Pipecat Cloud is available [here](https://docs.pipecat.cloud).
 ```shell
 pip install pipecatcloud
 
-# Note: you can use `pipecat` or `pcc` interchangeably
-
-pipecat --help
 pipecat --version
+pipecat --help
+
+# Note: you can use `pipecat` or `pcc` interchangeably
+pcc auth login
 ```
 
 ! All CLI commands have a `--help` flag that will display the command usage and options.
@@ -49,3 +50,18 @@ pipecat --version
 
 6. Deploy your agent `pipecat deploy starter-agent your-repository/your-agent-name:0.1`
 
+### Usage in Python scripts
+
+If want to programmatically start an agent within a Python script, you can use the `pipecatcloud.agent` module.
+
+```python
+from pipecatcloud.agent import Agent
+
+agent = Agent(
+    agent_name="your-agent-name",
+    organization="your-organization",
+    api_key="your-api-key",
+)
+
+await agent.start()
+```

{pipecatcloud-0.0.6 → pipecatcloud-0.0.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pipecatcloud"
-version = "0.0.6"
+version = "0.0.8"
 requires-python = ">=3.10"
 dependencies = [
     "aiohttp~=3.10.10",

{pipecatcloud-0.0.6 → pipecatcloud-0.0.8}/src/pipecatcloud/__init__.py

@@ -3,10 +3,5 @@ import sys
 
 from loguru import logger
 
-PIPECAT_CLI_NAME = "pcc"
-PIPECAT_CREDENTIALS_PATH = "~/.pipecatcloud.toml"
-PIPECAT_DEPLOY_CONFIG_PATH = ".pcc-deploy.toml"
-
-
 logger.remove()
 logger.add(sys.stderr, level=str(os.getenv("PCC_LOG_LEVEL", "INFO")))

pipecatcloud-0.0.8/src/pipecatcloud/_utils/auth_utils.py

@@ -0,0 +1,19 @@
+import functools
+
+from pipecatcloud._utils.console_utils import console
+from pipecatcloud.cli import PIPECAT_CLI_NAME
+from pipecatcloud.cli.config import config
+
+
+def requires_login(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        org = config.get("org")
+        token = config.get("token")
+        if org is None or token is None:
+            console.error(
+                f"You are not logged in. Please run `{PIPECAT_CLI_NAME} auth login` first.",
+            )
+            return
+        return func(*args, **kwargs)
+    return wrapper

pipecatcloud-0.0.8/src/pipecatcloud/_utils/console_utils.py

@@ -0,0 +1,76 @@
+from typing import Optional
+
+from rich.console import Console
+from rich.panel import Panel
+
+from pipecatcloud.cli import PANEL_TITLE_ERROR, PANEL_TITLE_SUCCESS
+from pipecatcloud.errors import ERROR_CODES
+
+
+class PipecatConsole(Console):
+    def success(
+            self,
+            message,
+            title: Optional[str] = None,
+            title_extra: Optional[str] = None,
+            subtitle: Optional[str] = None):
+
+        if not title:
+            title = f"{PANEL_TITLE_SUCCESS}{f' - {title_extra}' if title_extra is not None else ''}"
+
+        self.print(
+            Panel(
+                message,
+                title=f"[bold green]{title}[/bold green]",
+                subtitle=subtitle,
+                title_align="left",
+                subtitle_align="left",
+                border_style="green"))
+
+    def error(
+            self,
+            message,
+            title_extra: Optional[str] = None,
+            subtitle: Optional[str] = None):
+
+        title = f"{PANEL_TITLE_ERROR}{f' - {title_extra}' if title_extra is not None else ''}"
+
+        self.print(
+            Panel(
+                message,
+                title=f"[bold red]{title}[/bold red]",
+                subtitle=subtitle,
+                title_align="left",
+                subtitle_align="left",
+                border_style="red"))
+
+    def cancel(self):
+        self.print("[yellow]Cancelled by user[/yellow]")
+
+    def unauthorized(self):
+        self.api_error("401", "Unauthorized", hide_subtitle=True)
+
+    def api_error(
+            self,
+            error_code: Optional[str],
+            title: Optional[str] = "API Error",
+            hide_subtitle: bool = False):
+        DEFAULT_ERROR_MESSAGE = "Unknown error. Please contact support."
+        ERROR_MESSAGE = ERROR_CODES.get(error_code, None) if error_code else None
+
+        if not ERROR_MESSAGE:
+            hide_subtitle = True
+
+        error_message = ERROR_MESSAGE if ERROR_MESSAGE else DEFAULT_ERROR_MESSAGE
+        self.print(
+            Panel(
+                f"[red]{title}[/red]\n\n"
+                f"[dim]Error message:[/dim]\n{error_message}",
+                title=f"[bold red]{PANEL_TITLE_ERROR} - {error_code}[/bold red]",
+                subtitle=f"[dim]Docs: https://docs.pipecat.cloud/troubleshooting/#{error_code}[/dim]" if not hide_subtitle else None,
+                title_align="left",
+                subtitle_align="left",
+                border_style="red"))
+
+
+console = PipecatConsole()

pipecatcloud-0.0.8/src/pipecatcloud/_utils/deploy_utils.py

@@ -0,0 +1,98 @@
+import os
+from typing import Optional
+
+import toml
+from attr import dataclass
+from loguru import logger
+
+from pipecatcloud.exception import ConfigFileError
+
+DEPLOY_STATUS_MAP = {
+    "Unknown": "[dim]Waiting[/dim]",
+    "True": "[green]Ready[/green]",
+    "False": "[yellow]Creating[/yellow]"
+}
+
+
+@dataclass
+class ScalingParams:
+    min_instances: Optional[int] = 0
+    max_instances: Optional[int] = 10
+
+    def __attrs_post_init__(self):
+        if self.min_instances is not None:
+            if self.min_instances < 0:
+                raise ValueError("min_instances must be greater than or equal to 0")
+
+        if self.max_instances is not None:
+            if self.max_instances < 1:
+                raise ValueError("max_instances must be greater than 0")
+
+            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")
+
+    def to_dict(self):
+        return {
+            "min_instances": self.min_instances,
+            "max_instances": self.max_instances
+        }
+
+
+@dataclass
+class DeployConfigParams():
+    agent_name: Optional[str] = None
+    image: Optional[str] = None
+    image_credentials: Optional[str] = None
+    secret_set: Optional[str] = None
+    scaling: ScalingParams = ScalingParams()
+
+    def __attrs_post_init__(self):
+        if self.image is not None and ":" not in self.image:
+            raise ValueError("Provided image must include tag e.g. my-image:latest")
+
+    def to_dict(self):
+        return {
+            "agent_name": self.agent_name,
+            "image": self.image,
+            "image_credentials": self.image_credentials,
+            "secret_set": self.secret_set,
+            "scaling": self.scaling.to_dict() if self.scaling else None
+        }
+
+
+def load_deploy_config_file() -> Optional[DeployConfigParams]:
+    from pipecatcloud.cli.config import deploy_config_path
+
+    logger.debug(f"Deploy config path: {deploy_config_path}")
+    logger.debug(f"Deploy config path exists: {os.path.exists(deploy_config_path)}")
+
+    try:
+        with open(deploy_config_path, "r") as f:
+            config_data = toml.load(f)
+
+        # Extract scaling parameters if present
+        scaling_data = config_data.pop('scaling', {})
+        scaling_params = ScalingParams(**scaling_data)
+
+        # Create DeployConfigParams with validated data
+        validated_config = DeployConfigParams(
+            **config_data,
+            scaling=scaling_params,
+        )
+
+        # Check for unexpected keys
+        expected_keys = {
+            'agent_name',
+            'image',
+            'image_credentials',
+            'secret_set',
+            'scaling'}
+        unexpected_keys = set(config_data.keys()) - expected_keys
+        if unexpected_keys:
+            raise ConfigFileError(f"Unexpected keys in config file: {unexpected_keys}")
+
+        return validated_config
+
+    except Exception as e:
+        logger.debug(e)
+        raise ConfigFileError(str(e))

pipecatcloud-0.0.8/src/pipecatcloud/_utils/local_runner.py

@@ -0,0 +1,34 @@
+
+import fastapi
+import uvicorn
+from loguru import logger
+
+
+async def start_server(entrypoint: str, host: str = "0.0.0.0", port: int = 8000):
+    """Start a FastAPI server with the specified routes.
+
+    Args:
+        entrypoint (str): The entry point identifier
+    """
+    logger.debug(f"Starting local bot runner for {entrypoint}")
+    app = fastapi.FastAPI(
+        openapi_url=None,
+        docs_url=None,
+        redoc_url=None
+    )
+
+    # @TODO dynamically load entrypoint
+
+    @app.get("/health")
+    async def health_check():
+        return {"status": "healthy"}
+
+    config = uvicorn.Config(
+        app,
+        host=host,
+        port=port,
+        log_level="error",
+    )
+    server = uvicorn.Server(config)
+
+    await server.serve()