pipecatcloud 0.0.6__tar.gz

pipecatcloud-0.0.6/.github/workflows/python-publish.yml

@@ -0,0 +1,98 @@
+# 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
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Setup virtual environment
+        run: |
+          python -m venv .venv
+      - name: Install basic Python dependencies
+        run: |
+          source .venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
+      - name: Build project
+        run: |
+          source .venv/bin/activate
+          python -m build
+      - name: Install project and other Python dependencies
+        run: |
+          source .venv/bin/activate
+          pip install --editable .
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      id-token: write
+      contents: read
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pipecatcloud
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+
+      - name: Read CHANGELOG
+        id: changelog
+        run: |
+          if [ -f "CHANGELOG.md" ]; then
+            echo "CHANGELOG_CONTENT<<EOF" >> $GITHUB_ENV
+            cat CHANGELOG.md >> $GITHUB_ENV
+            echo "EOF" >> $GITHUB_ENV
+          else
+            echo "CHANGELOG_CONTENT=No changelog available." >> $GITHUB_ENV
+          fi
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref }}
+          name: Release ${{ github.ref_name }}
+          body: |
+            ${{ env.CHANGELOG_CONTENT }}
+          draft: false
+          prerelease: false
+          files: |
+            dist/*.tar.gz
+            dist/*.whl

pipecatcloud-0.0.6/.gitignore

@@ -0,0 +1,92 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+dist/
+*.egg-info/
+*.egg
+*.egg-info
+.installed.cfg
+.eggs/
+downloads/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+MANIFEST
+
+# Virtual Environments
+venv/
+env/
+.env
+.venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.idea/
+.vscode/
+.spyderproject
+.spyproject
+.ropeproject
+
+# Testing and Coverage
+.coverage
+.coverage.*
+htmlcov/
+.pytest_cache/
+.tox/
+.nox/
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+cover/
+
+# Logs and Databases
+*.log
+*.db
+db.sqlite3
+db.sqlite3-journal
+pip-log.txt
+
+# System Files
+.DS_Store
+Thumbs.db
+desktop.ini
+*.swp
+*.swo
+*.bak
+*.tmp
+*~
+
+# Build and Documentation
+docs/_build/
+.pybuilder/
+target/
+instance/
+.webassets-cache
+.pdm.toml
+.pdm-python
+.pdm-build/
+__pypackages__/
+
+# Other
+*.mo
+*.pot
+*.sage.py
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.pyre/
+.pytype/
+cython_debug/
+.ipynb_checkpoints

pipecatcloud-0.0.6/CHANGELOG.md

@@ -0,0 +1,28 @@
+# 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.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/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.2
+Name: pipecatcloud
+Version: 0.0.6
+Requires-Python: >=3.10
+Requires-Dist: aiohttp~=3.10.10
+Requires-Dist: fastapi~=0.115.5
+Requires-Dist: loguru~=0.7.2
+Requires-Dist: python-dotenv~=1.0.1
+Requires-Dist: uvicorn~=0.32.0
+Requires-Dist: typer~=0.13.0
+Requires-Dist: synchronicity~=0.7.6
+Requires-Dist: toml~=0.10.2
+Requires-Dist: questionary~=2.1.0

pipecatcloud-0.0.6/README.md

@@ -0,0 +1,51 @@
+
+<h1><div align="center">
+ <img alt="pipecat cloud" width="500px" height="auto" src="./pipecat-cloud.png">
+</div></h1>
+
+
+[![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)
+
+# Pipecat Cloud
+
+Python module and CLI for interacting with [Pipecat Cloud](https://pipecat.cloud).
+
+### Requirements
+
+- Python 3.10+
+- Docker and a Docker repository (e.g. Docker Hub)
+- Active [Pipecat Cloud](https://dashboard.pipecat.cloud)
+ account
+
+### Documentation
+
+Documentation for Pipecat Cloud is available [here](https://docs.pipecat.cloud).
+
+### Installation
+
+```shell
+pip install pipecatcloud
+
+# Note: you can use `pipecat` or `pcc` interchangeably
+
+pipecat --help
+pipecat --version
+```
+
+! All CLI commands have a `--help` flag that will display the command usage and options.
+
+## Usage
+
+1. Create an account at [Pipecat Cloud](https://pipecat.cloud)
+
+2. Login to your account `pipecat auth login`
+
+3. (Optional): Clone the starter agent [here](https://github.com/pipecat-ai/pipecat-cloud-starter-agent)
+
+4. Build your agent `docker build --platform linux/arm64 -t your-agent-name .`
+
+5. Push your Docker image to your repository `docker push your-repository/your-agent-name:0.1`
+
+6. Deploy your agent `pipecat deploy starter-agent your-repository/your-agent-name:0.1`
+

pipecatcloud-0.0.6/dev-requirements.txt

@@ -0,0 +1,8 @@
+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.0.6/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pipecatcloud"
+version = "0.0.6"
+requires-python = ">=3.10"
+dependencies = [
+    "aiohttp~=3.10.10",
+    "fastapi~=0.115.5",
+    "loguru~=0.7.2",
+    "python-dotenv~=1.0.1",
+    "uvicorn~=0.32.0",
+    "typer~=0.13.0",
+    "synchronicity~=0.7.6",
+    "toml~=0.10.2",
+    "questionary~=2.1.0",
+]
+
+[project.scripts]
+pcc = "pipecatcloud.__main__:main"
+pipecat = "pipecatcloud.__main__:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["pipecatcloud*"]
+
+[tool.ruff]
+exclude = ["*_pb2.py"]
+line-length = 100

pipecatcloud-0.0.6/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pipecatcloud-0.0.6/src/pipecatcloud/__init__.py

@@ -0,0 +1,12 @@
+import os
+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.6/src/pipecatcloud/__main__.py

@@ -0,0 +1,9 @@
+from pipecatcloud.cli.entry_point import entrypoint_cli
+
+
+def main():
+    entrypoint_cli()
+
+
+if __name__ == "__main__":
+    main()

pipecatcloud-0.0.6/src/pipecatcloud/__version__.py

@@ -0,0 +1,6 @@
+from pathlib import Path
+
+import toml
+
+pyproject_path = Path(__file__).parent.parent.parent / "pyproject.toml"
+version = toml.load(pyproject_path)["project"]["version"]

pipecatcloud-0.0.6/src/pipecatcloud/_utils/agent_utils.py

@@ -0,0 +1,9 @@
+def handle_agent_start_error(response_code: int) -> str:
+    if response_code == 404:
+        return "PCC-1005"
+    elif response_code == 400:
+        return "PCC-1004"
+    elif response_code == 401:
+        return "PCC-1006"
+    else:
+        return "PCC-1000"

pipecatcloud-0.0.6/src/pipecatcloud/_utils/async_utils.py

@@ -0,0 +1,20 @@
+import inspect
+from typing import (
+    TypeVar,
+)
+
+import synchronicity
+
+synchronizer = synchronicity.Synchronizer()
+
+
+def synchronize_api(obj, target_module=None):
+    if inspect.isclass(obj) or inspect.isfunction(obj):
+        blocking_name = obj.__name__.lstrip("_")
+    elif isinstance(obj, TypeVar):
+        blocking_name = "_BLOCKING_" + obj.__name__
+    else:
+        blocking_name = None
+    if target_module is None:
+        target_module = obj.__module__
+    return synchronizer.create_blocking(obj, blocking_name, target_module=target_module)

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

@@ -0,0 +1,26 @@
+import functools
+
+from rich.console import Console
+from rich.panel import Panel
+
+from pipecatcloud import PIPECAT_CLI_NAME
+from pipecatcloud.cli import PANEL_TITLE_ERROR
+from pipecatcloud.config import config
+
+
+def requires_login(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        console = Console()
+        org = config.get("org")
+        token = config.get("token")
+        if org is None or token is None:
+            console.print(Panel(
+                f"You are not logged in. Please run `{PIPECAT_CLI_NAME} auth login` first.",
+                title=f"[red]{PANEL_TITLE_ERROR}[/red]",
+                title_align="left",
+                border_style="red",
+            ))
+            return
+        return func(*args, **kwargs)
+    return wrapper

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

@@ -0,0 +1,25 @@
+
+from typing import Optional
+
+from rich.console import Console
+from rich.panel import Panel
+
+from pipecatcloud.cli import PANEL_TITLE_ERROR
+from pipecatcloud.errors import ERROR_CODES
+
+console = Console()
+
+
+def print_api_error(error_code: Optional[str], title: str):
+    error_message = "Unknown error" if not error_code else ERROR_CODES.get(
+        error_code, "Unknown error")
+
+    console.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]",
+        title_align="left",
+        subtitle_align="left",
+        border_style="red"
+    ))

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

@@ -0,0 +1,18 @@
+from loguru import logger
+
+
+def load_deploy_config_file() -> dict | None:
+    import os
+
+    import toml
+
+    from pipecatcloud.config import deploy_config_path
+
+    logger.info(f"Deploy config path: {deploy_config_path}")
+    logger.info(f"Deploy config path exists: {os.path.exists(deploy_config_path)}")
+
+    try:
+        with open(deploy_config_path, "r") as f:
+            return toml.load(f)
+    except Exception:
+        return None

pipecatcloud-0.0.6/src/pipecatcloud/_utils/http_utils.py

@@ -0,0 +1,43 @@
+import contextlib
+import logging
+import socket
+
+from aiohttp.web import Application
+from aiohttp.web_runner import AppRunner, SockSite
+
+logger = logging.getLogger(__name__)
+
+
+@contextlib.asynccontextmanager
+async def run_temporary_http_server(app: Application):
+    sock = socket.socket()
+    try:
+        sock.bind(("", 0))
+        port = sock.getsockname()[1]
+        host = f"http://127.0.0.1:{port}"
+
+        runner = AppRunner(app)
+        await runner.setup()
+        site = SockSite(runner, sock=sock)
+        await site.start()
+        try:
+            yield host
+        finally:
+            await runner.cleanup()
+    except Exception as e:
+        logger.error(f"Error setting up temporary HTTP server: {e}")
+        raise
+    finally:
+        sock.close()
+
+
+def construct_api_url(path: str) -> str:
+    from pipecatcloud.config import config
+
+    if not config.get("server_url", ""):
+        raise ValueError("Server URL is not set")
+
+    if not config.get(path, ""):
+        raise ValueError(f"Endpoint {path} is not set")
+
+    return f"{config.get('server_url', '')}{config.get(path, '')}"

pipecatcloud-0.0.6/src/pipecatcloud/agent.py

@@ -0,0 +1,83 @@
+from dataclasses import dataclass
+from typing import Optional
+
+import aiohttp
+from loguru import logger
+
+from pipecatcloud._utils.agent_utils import handle_agent_start_error
+from pipecatcloud._utils.http_utils import construct_api_url
+from pipecatcloud.exception import AgentStartError
+
+
+@dataclass
+class AgentParams:
+    data: Optional[dict] = None
+    use_daily: Optional[bool] = False
+
+
+class Agent:
+    def __init__(
+        self,
+        agent_name: str,
+        organization: str,
+        api_key: str,
+        params: Optional[AgentParams] = None,
+    ):
+        self.agent_name = agent_name
+        self.api_key = api_key
+        self.organization = organization
+
+        if not self.organization or not self.agent_name:
+            raise ValueError("Organization and agent name are required")
+
+        self.params = params or AgentParams()
+
+    async def start(self) -> bool:
+        if not self.api_key:
+            raise AgentStartError(error_code="PCC-1002")
+
+        # @TODO: Public route not yet implemented
+        """
+        # Check deployment heath
+        error_code = None
+        agent_data = None
+
+        try:
+            async with aiohttp.ClientSession() as session:
+                response = await session.get(
+                    f"{construct_api_url('services_path').format(org=self.organization)}/{self.agent_name}",
+                    headers={"Authorization": f"Bearer {self.api_key}"},
+                )
+                if response.status != 200:
+                    error_code = str(response.status)
+                    response.raise_for_status()
+                agent_data = await response.json()
+                if agent_data is None or not agent_data["ready"]:
+                    raise AgentNotHealthyError(error_code=error_code)
+        except Exception as e:
+            raise Exception(f"Error checking agent health: {e}")
+        """
+
+        logger.debug(f"Starting agent {self.agent_name}")
+
+        start_error_code = None
+        try:
+            async with aiohttp.ClientSession() as session:
+                response = await session.post(
+                    f"{construct_api_url('start_path').format(service=self.agent_name)}",
+                    headers={"Authorization": f"Bearer {self.api_key}"},
+                    json={
+                        "createDailyRoom": bool(self.params.use_daily),
+                        "body": self.params.data
+                    }
+                )
+                if response.status != 200:
+                    start_error_code = handle_agent_start_error(response.status)
+                    response.raise_for_status()
+                else:
+                    logger.debug(f"Agent {self.agent_name} started successfully")
+        except Exception as e:
+            logger.error(f"Error starting agent {self.agent_name}: {e}")
+            raise AgentStartError(error_code=start_error_code)
+
+        return True

pipecatcloud-0.0.6/src/pipecatcloud/cli/__init__.py

@@ -0,0 +1,3 @@
+PANEL_TITLE_ERROR = "ᓚᘏᗢ Error"
+PANEL_TITLE_SUCCESS = "ᓚᘏᗢ Success"
+PANEL_TITLE_NOT_IMPLEMENTED = "ᓚᘏᗢ Not yet implemented"