pipecatcloud


Namepipecatcloud JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryCloud hosting for Pipecat AI applications
upload_time2025-07-09 21:06:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseBSD 2-Clause License
keywords pipecat pipecat-ai voice ai llm
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1><div align="center">
 <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)
[![PyPI](https://img.shields.io/pypi/v/pipecatcloud)](https://pypi.org/project/pipecatcloud)

# Pipecat Cloud

Python module and CLI for interacting with [Pipecat Cloud](https://pipecat.daily.co).

### Requirements

- Python 3.10+
- Docker and a Docker repository (e.g. Docker Hub)
- Active [Pipecat Cloud](https://pipecat.daily.co)
  account

### Documentation

Documentation for Pipecat Cloud is available [here](https://docs.pipecat.daily.co).

### Installation

```shell
pip install pipecatcloud

pcc --version
pcc --help

# Note: you can use `pcc` or `pipecatcloud` interchangeably
pcc auth login
```

! 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.daily.co)

2. Login to your account `pcc auth login`

3. (Optional): Clone the starter agent [here](https://github.com/daily-co/pipecat-cloud-starter)

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 `pcc 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.session` module.

```python
from pipecatcloud.session import Session
from pipecatcloud.exception import AgentStartError
import asyncio

async def main():
    session = Session(
        agent_name="your-agent-name",
        api_key="pk_...",
    )

    try:
        await session.start()
    except AgentStartError as e:
        print(e)
    except Exception as e:
        raise (e)

if __name__ == "__main__":
    asyncio.run(main())
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pipecatcloud",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "pipecat, pipecat-ai, voice, ai, llm",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/5c/5a/9bf1b4efb2940ff2586b2488035123211ec774d0e90c7b1a0910ebef6316/pipecatcloud-0.2.0.tar.gz",
    "platform": null,
    "description": "<h1><div align=\"center\">\n <img alt=\"pipecat cloud\" width=\"500px\" height=\"auto\" src=\"https://raw.githubusercontent.com/daily-co/pipecat-cloud/main/pipecat-cloud.png\">\n</div></h1>\n\n[![Docs](https://img.shields.io/badge/documentation-blue)](https://docs.pipecat.daily.co)\n[![PyPI](https://img.shields.io/pypi/v/pipecatcloud)](https://pypi.org/project/pipecatcloud)\n\n# Pipecat Cloud\n\nPython module and CLI for interacting with [Pipecat Cloud](https://pipecat.daily.co).\n\n### Requirements\n\n- Python 3.10+\n- Docker and a Docker repository (e.g. Docker Hub)\n- Active [Pipecat Cloud](https://pipecat.daily.co)\n  account\n\n### Documentation\n\nDocumentation for Pipecat Cloud is available [here](https://docs.pipecat.daily.co).\n\n### Installation\n\n```shell\npip install pipecatcloud\n\npcc --version\npcc --help\n\n# Note: you can use `pcc` or `pipecatcloud` interchangeably\npcc auth login\n```\n\n! All CLI commands have a `--help` flag that will display the command usage and options.\n\n## Usage\n\n1. Create an account at [Pipecat Cloud](https://pipecat.daily.co)\n\n2. Login to your account `pcc auth login`\n\n3. (Optional): Clone the starter agent [here](https://github.com/daily-co/pipecat-cloud-starter)\n\n4. Build your agent `docker build --platform linux/arm64 -t your-agent-name .`\n\n5. Push your Docker image to your repository `docker push your-repository/your-agent-name:0.1`\n\n6. Deploy your agent `pcc deploy starter-agent your-repository/your-agent-name:0.1`\n\n### Usage in Python scripts\n\nIf want to programmatically start an agent within a Python script, you can use the `pipecatcloud.session` module.\n\n```python\nfrom pipecatcloud.session import Session\nfrom pipecatcloud.exception import AgentStartError\nimport asyncio\n\nasync def main():\n    session = Session(\n        agent_name=\"your-agent-name\",\n        api_key=\"pk_...\",\n    )\n\n    try:\n        await session.start()\n    except AgentStartError as e:\n        print(e)\n    except Exception as e:\n        raise (e)\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n",
    "bugtrack_url": null,
    "license": "BSD 2-Clause License",
    "summary": "Cloud hosting for Pipecat AI applications",
    "version": "0.2.0",
    "project_urls": {
        "Website": "https://docs.pipecat.daily.co/"
    },
    "split_keywords": [
        "pipecat",
        " pipecat-ai",
        " voice",
        " ai",
        " llm"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e4fe46aab37a9f84a9a74445c2417479e3fe4f6087fbcf789da6cbc27861c04d",
                "md5": "29e31b307f3c64e19a5be630c7df6ee3",
                "sha256": "3d3860ede3243ddd578e292b538f36871c95191d6d7c0d092a48702b7dc93585"
            },
            "downloads": -1,
            "filename": "pipecatcloud-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "29e31b307f3c64e19a5be630c7df6ee3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 44205,
            "upload_time": "2025-07-09T21:06:12",
            "upload_time_iso_8601": "2025-07-09T21:06:12.655473Z",
            "url": "https://files.pythonhosted.org/packages/e4/fe/46aab37a9f84a9a74445c2417479e3fe4f6087fbcf789da6cbc27861c04d/pipecatcloud-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "5c5a9bf1b4efb2940ff2586b2488035123211ec774d0e90c7b1a0910ebef6316",
                "md5": "16982ea1b2613d222c4441521166acb9",
                "sha256": "a18e13dffae05acd30711251ded516ce34d5075b7b88c9496cd13cc9ba923f52"
            },
            "downloads": -1,
            "filename": "pipecatcloud-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "16982ea1b2613d222c4441521166acb9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 53179,
            "upload_time": "2025-07-09T21:06:14",
            "upload_time_iso_8601": "2025-07-09T21:06:14.218372Z",
            "url": "https://files.pythonhosted.org/packages/5c/5a/9bf1b4efb2940ff2586b2488035123211ec774d0e90c7b1a0910ebef6316/pipecatcloud-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 21:06:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pipecatcloud"
}
        
Elapsed time: 0.40357s