pipecat-ai-small-webrtc-prebuilt

SmallWebRTC Prebuilt

A simple, ready-to-use client for testing the SmallWebRTCTransport.

This prebuilt client provides basic WebRTC functionality and serves as a lightweight tool to quickly verify transport behavior without needing a custom implementation.

Ideal for development, debugging, and quick prototyping.

📦 Installation & Usage

If you just want to use the prebuilt WebRTC client in your own Python project:

✅ Install from PyPI

pip install pipecat-ai-small-webrtc-prebuilt

🧰 Example Usage

from fastapi import FastAPI
from fastapi.responses import RedirectResponse
from pipecat_ai_small_webrtc_prebuilt.frontend import SmallWebRTCPrebuiltUI

app = FastAPI()

# Mount the frontend at /prebuilt
app.mount("/prebuilt", SmallWebRTCPrebuiltUI)

@app.get("/", include_in_schema=False)
async def root_redirect():
    return RedirectResponse(url="/prebuilt/")

🧪 Try a Sample App

Want to see it in action? Check out our sample app demonstrating how to use this module:

• 👉 Sample App

⌨ Development Quick Start

🔧 Set Up the Environment

• Clone the Repository

git clone https://github.com/your-org/small-webrtc-prebuilt.git

• Create and activate a virtual environment:

  cd small-webrtc-prebuilt
  python3 -m venv venv
  source venv/bin/activate  # On Windows: venv\Scripts\activate
  

• Install dependencies:

  pip install -r requirements.txt
  

🚀 Publishing

• Prepare to dist:

./scripts/prepare_dist.sh

• Test the build using TestPyPI with Twine:

Upload to TestPyPI using twine

twine upload --repository testpypi dist/*

Uninstall previous production version

pip uninstall pipecat-ai-small-webrtc-prebuilt

Test using pip to download packages from TestPyPI instead of PyPI

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pipecat-ai-small-webrtc-prebuilt

Double check version

pip list |grep pipecat-ai-small-webrtc-prebuilt

Run test...

Once you are happy, publish it to production.

twine upload dist/*

Profit.