Skip to main content

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

Project description

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:

⌨ Development Quick Start

🔧 Set Up the Environment

  1. Clone the Repository
git clone https://github.com/your-org/small-webrtc-prebuilt.git
  1. Create and activate a virtual environment:

    cd small-webrtc-prebuilt
    python3 -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    
  2. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipecat_ai_small_webrtc_prebuilt-0.7.0.tar.gz (104.2 kB view details)

Uploaded Source

File details

Details for the file pipecat_ai_small_webrtc_prebuilt-0.7.0.tar.gz.

File metadata

File hashes

Hashes for pipecat_ai_small_webrtc_prebuilt-0.7.0.tar.gz
Algorithm Hash digest
SHA256 d4739f8894971028865629975e05712f4b96481973554fc3e3627161a4b0fecd
MD5 ba69a56bb2a68850b410f6eeaa19e57b
BLAKE2b-256 bcd73fb21ff1f42bad009ee7cf1fcc06d7a3918c8554c9949d225c9b976370cb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page