From b78ae40d3cd8f59e871fde779081c028b41590c7 Mon Sep 17 00:00:00 2001 From: Mark Backman Date: Mon, 30 Mar 2026 18:20:41 -0400 Subject: [PATCH] Remove quickstart example from repo --- .github/workflows/sync-quickstart.yaml | 51 --------- README.md | 2 +- examples/README.md | 1 - examples/quickstart/Dockerfile | 16 --- examples/quickstart/README.md | 150 ------------------------- examples/quickstart/bot.py | 145 ------------------------ examples/quickstart/env.example | 6 - examples/quickstart/pcc-deploy.toml | 6 - examples/quickstart/pyproject.toml | 20 ---- 9 files changed, 1 insertion(+), 396 deletions(-) delete mode 100644 .github/workflows/sync-quickstart.yaml delete mode 100644 examples/quickstart/Dockerfile delete mode 100644 examples/quickstart/README.md delete mode 100644 examples/quickstart/bot.py delete mode 100644 examples/quickstart/env.example delete mode 100644 examples/quickstart/pcc-deploy.toml delete mode 100644 examples/quickstart/pyproject.toml diff --git a/.github/workflows/sync-quickstart.yaml b/.github/workflows/sync-quickstart.yaml deleted file mode 100644 index 6f4e25b50..000000000 --- a/.github/workflows/sync-quickstart.yaml +++ /dev/null @@ -1,51 +0,0 @@ -name: Sync Quickstart to pipecat-quickstart repo - -on: - push: - branches: [main] - paths: - - 'examples/quickstart/**' - workflow_dispatch: # Manual trigger - -jobs: - sync-quickstart: - runs-on: ubuntu-latest - steps: - - name: Checkout main repo - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Checkout quickstart repo - uses: actions/checkout@v4 - with: - repository: pipecat-ai/pipecat-quickstart - token: ${{ secrets.QUICKSTART_SYNC_TOKEN }} - path: quickstart-repo - - - name: Sync files (excluding uv.lock and README.md) - run: | - # Copy all files except uv.lock and README.md - find examples/quickstart -type f \ - -not -name "README.md" \ - -not -name "uv.lock" \ - -exec cp {} quickstart-repo/ \; - - - name: Commit and push changes - run: | - cd quickstart-repo - git config user.name "GitHub Action" - git config user.email "action@github.com" - git add . - - # Only commit if there are changes - if ! git diff --staged --quiet; then - git commit -m "Sync from pipecat main repo - - Updated files from examples/quickstart/ - Commit: ${{ github.sha }} - " - git push - else - echo "No changes to sync" - fi diff --git a/README.md b/README.md index ddd4db1dc..4b62b55e7 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ **Pipecat** is an open-source Python framework for building real-time voice and multimodal conversational agents. Orchestrate audio and video, AI services, different transports, and conversation pipelines effortlesslyβ€”so you can focus on what makes your agent unique. -> Want to dive right in? Try the [quickstart](https://docs.pipecat.ai/getting-started/quickstart). +> Want to dive right in? Run `pipecat init quickstart` or follow the [quickstart guide](https://docs.pipecat.ai/getting-started/quickstart). ## πŸš€ What You Can Build diff --git a/examples/README.md b/examples/README.md index 62c7124e8..7eae41021 100644 --- a/examples/README.md +++ b/examples/README.md @@ -6,7 +6,6 @@ This directory contains examples to help you learn how to build with Pipecat. New to Pipecat? Start here: -- **[Quickstart](quickstart/)** - Get your first voice AI bot running in 5 minutes _(coming soon)_ - **[Client/Server Web](client-server-web/)** - Learn to build web applications with Pipecat's client SDKs _(coming soon)_ - **[Phone Bot with Twilio](phone-bot-twilio/)** - Connect your bot to a phone number _(coming soon)_ diff --git a/examples/quickstart/Dockerfile b/examples/quickstart/Dockerfile deleted file mode 100644 index a556a9e7b..000000000 --- a/examples/quickstart/Dockerfile +++ /dev/null @@ -1,16 +0,0 @@ -FROM dailyco/pipecat-base:latest - -# Enable bytecode compilation -ENV UV_COMPILE_BYTECODE=1 - -# Copy from the cache instead of linking since it's a mounted volume -ENV UV_LINK_MODE=copy - -# Install the project's dependencies using the lockfile and settings -RUN --mount=type=cache,target=/root/.cache/uv \ - --mount=type=bind,source=uv.lock,target=uv.lock \ - --mount=type=bind,source=pyproject.toml,target=pyproject.toml \ - uv sync --locked --no-install-project --no-dev - -# Copy the application code -COPY ./bot.py bot.py diff --git a/examples/quickstart/README.md b/examples/quickstart/README.md deleted file mode 100644 index 6374d622c..000000000 --- a/examples/quickstart/README.md +++ /dev/null @@ -1,150 +0,0 @@ -# Pipecat Quickstart - -Build and deploy your first voice AI bot in under 10 minutes. Develop locally, then scale to production on Pipecat Cloud. - -**Two steps**: [🏠 Local Development](#run-your-bot-locally) β†’ [☁️ Production Deployment](#deploy-to-production) - -> 🎯 Quick start: Local bot in 5 minutes, production deployment in 5 more - -## Step 1: Local Development (5 min) - -### Prerequisites - -#### Environment - -- Python 3.10 or later -- [uv](https://docs.astral.sh/uv/getting-started/installation/) package manager installed - -#### AI Service API keys - -You'll need API keys from three services: - -- [Deepgram](https://console.deepgram.com/signup) for Speech-to-Text -- [OpenAI](https://auth.openai.com/create-account) for LLM inference -- [Cartesia](https://play.cartesia.ai/sign-up) for Text-to-Speech - -> πŸ’‘ **Tip**: Sign up for all three now. You'll need them for both local and cloud deployment. - -### Setup - -Navigate to the quickstart directory and set up your environment. - -1. Install dependencies: - - ```bash - uv sync - ``` - -2. Configure your API keys: - - Create a `.env` file: - - ```bash - cp env.example .env - ``` - - Then, add your API keys: - - ```ini - DEEPGRAM_API_KEY=your_deepgram_api_key - OPENAI_API_KEY=your_openai_api_key - CARTESIA_API_KEY=your_cartesia_api_key - ``` - -### Run your bot locally - -```bash -uv run bot.py -``` - -**Open http://localhost:7860 in your browser** and click `Connect` to start talking to your bot. - -> πŸ’‘ First run note: The initial startup may take ~20 seconds as Pipecat downloads required models and imports. - -πŸŽ‰ **Success!** Your bot is running locally. Now let's deploy it to production so others can use it. - ---- - -## Step 2: Deploy to Production (5 min) - -Transform your local bot into a production-ready service. Pipecat Cloud handles scaling, monitoring, and global deployment. - -### Prerequisites - -1. [Sign up for Pipecat Cloud](https://pipecat.daily.co/sign-up). - -2. Install the Pipecat CLI: - - ```bash - uv tool install pipecat-ai-cli - ``` - -> πŸ’‘ Tip: You can run the `pipecat` CLI using the `pc` alias. - -### Configure your deployment - -The `pcc-deploy.toml` file tells Pipecat Cloud how to run your bot. - -```ini -agent_name = "quickstart" -secret_set = "quickstart-secrets" - -[scaling] - min_agents = 1 -``` - -**Understanding the TOML file settings:** - -- `agent_name`: Your bot's name in Pipecat Cloud -- `secret_set`: Where your API keys are stored securely -- `min_agents`: Number of bot instances to keep ready (1 = instant start) - -### Log in to Pipecat Cloud - -To start using the CLI, authenticate to Pipecat Cloud: - -```bash -pipecat cloud auth login -``` - -You'll be presented with a link and six-digit code that you can click to authenticate your client. - -### Configure secrets - -Upload your API keys to Pipecat Cloud's secure storage: - -```bash -pipecat cloud secrets set quickstart-secrets --file .env -``` - -This creates a secret set called `quickstart-secrets` (matching your TOML file) and uploads all your API keys from `.env`. - -### Deploy - -Deploy to Pipecat Cloud: - -```bash -pipecat cloud deploy -``` - -This pushes your project files to Pipecat Cloud where a docker image is built and deployed into production. - -### Connect to your agent - -1. Open your [Pipecat Cloud dashboard](https://pipecat.daily.co/) -2. Select your `quickstart` agent β†’ **Sandbox** -3. Allow microphone access and click **Connect** - ---- - -## What's Next? - -**πŸ”§ Customize your bot**: Modify `bot.py` to change personality, add functions, or integrate with your data -**πŸ“š Learn more**: Check out [Pipecat's docs](https://docs.pipecat.ai/) for advanced features -**πŸ’¬ Get help**: Join [Pipecat's Discord](https://discord.gg/pipecat) to connect with the community - -### Troubleshooting - -- **Browser permissions**: Allow microphone access when prompted -- **Connection issues**: Try a different browser or check VPN/firewall settings -- **Audio issues**: Verify microphone and speakers are working and not muted diff --git a/examples/quickstart/bot.py b/examples/quickstart/bot.py deleted file mode 100644 index b4f392cab..000000000 --- a/examples/quickstart/bot.py +++ /dev/null @@ -1,145 +0,0 @@ -# -# Copyright (c) 2024-2026, Daily -# -# SPDX-License-Identifier: BSD 2-Clause License -# - -"""Pipecat Quickstart Example. - -The example runs a simple voice AI bot that you can connect to using your -browser and speak with it. You can also deploy this bot to Pipecat Cloud. - -Required AI services: -- Deepgram (Speech-to-Text) -- OpenAI (LLM) -- Cartesia (Text-to-Speech) - -Run the bot using:: - - uv run bot.py -""" - -import os - -from dotenv import load_dotenv -from loguru import logger - -print("πŸš€ Starting Pipecat bot...") -print("⏳ Loading models and imports (20 seconds, first run only)\n") - -logger.info("Loading Silero VAD model...") -from pipecat.audio.vad.silero import SileroVADAnalyzer - -logger.info("βœ… Silero VAD model loaded") - -from pipecat.frames.frames import LLMRunFrame - -logger.info("Loading pipeline components...") -from pipecat.pipeline.pipeline import Pipeline -from pipecat.pipeline.runner import PipelineRunner -from pipecat.pipeline.task import PipelineParams, PipelineTask -from pipecat.processors.aggregators.llm_context import LLMContext -from pipecat.processors.aggregators.llm_response_universal import ( - LLMContextAggregatorPair, - LLMUserAggregatorParams, -) -from pipecat.runner.types import RunnerArguments -from pipecat.runner.utils import create_transport -from pipecat.services.cartesia.tts import CartesiaTTSService -from pipecat.services.deepgram.stt import DeepgramSTTService -from pipecat.services.openai.llm import OpenAILLMService -from pipecat.transports.base_transport import BaseTransport, TransportParams -from pipecat.transports.daily.transport import DailyParams - -logger.info("βœ… All components loaded successfully!") - -load_dotenv(override=True) - - -async def run_bot(transport: BaseTransport, runner_args: RunnerArguments): - logger.info(f"Starting bot") - - stt = DeepgramSTTService(api_key=os.getenv("DEEPGRAM_API_KEY")) - - tts = CartesiaTTSService( - api_key=os.getenv("CARTESIA_API_KEY"), - settings=CartesiaTTSService.Settings( - voice="71a7ad14-091c-4e8e-a314-022ece01c121", # British Reading Lady - ), - ) - - llm = OpenAILLMService( - api_key=os.getenv("OPENAI_API_KEY"), - settings=OpenAILLMService.Settings( - system_instruction="You are a friendly AI assistant. Respond naturally and keep your answers conversational.", - ), - ) - - context = LLMContext() - user_aggregator, assistant_aggregator = LLMContextAggregatorPair( - context, - user_params=LLMUserAggregatorParams(vad_analyzer=SileroVADAnalyzer()), - ) - - pipeline = Pipeline( - [ - transport.input(), # Transport user input - stt, - user_aggregator, # User responses - llm, # LLM - tts, # TTS - transport.output(), # Transport bot output - assistant_aggregator, # Assistant spoken responses - ] - ) - - task = PipelineTask( - pipeline, - params=PipelineParams( - enable_metrics=True, - enable_usage_metrics=True, - ), - ) - - @transport.event_handler("on_client_connected") - async def on_client_connected(transport, client): - logger.info(f"Client connected") - # Kick off the conversation. - context.add_message( - {"role": "developer", "content": "Say hello and briefly introduce yourself."} - ) - await task.queue_frames([LLMRunFrame()]) - - @transport.event_handler("on_client_disconnected") - async def on_client_disconnected(transport, client): - logger.info(f"Client disconnected") - await task.cancel() - - runner = PipelineRunner(handle_sigint=runner_args.handle_sigint) - - await runner.run(task) - - -async def bot(runner_args: RunnerArguments): - """Main bot entry point for the bot starter.""" - - transport_params = { - "daily": lambda: DailyParams( - audio_in_enabled=True, - audio_out_enabled=True, - ), - "webrtc": lambda: TransportParams( - audio_in_enabled=True, - audio_out_enabled=True, - ), - } - - transport = await create_transport(runner_args, transport_params) - - await run_bot(transport, runner_args) - - -if __name__ == "__main__": - from pipecat.runner.run import main - - main() diff --git a/examples/quickstart/env.example b/examples/quickstart/env.example deleted file mode 100644 index 36048f91f..000000000 --- a/examples/quickstart/env.example +++ /dev/null @@ -1,6 +0,0 @@ -DEEPGRAM_API_KEY=your_deepgram_api_key -OPENAI_API_KEY=your_openai_api_key -CARTESIA_API_KEY=your_cartesia_api_key - -# Optional: Connect via Daily WebRTC locally -DAILY_API_KEY=your_daily_api_key \ No newline at end of file diff --git a/examples/quickstart/pcc-deploy.toml b/examples/quickstart/pcc-deploy.toml deleted file mode 100644 index 5562f117e..000000000 --- a/examples/quickstart/pcc-deploy.toml +++ /dev/null @@ -1,6 +0,0 @@ -agent_name = "quickstart" -secret_set = "quickstart-secrets" -agent_profile = "agent-1x" - -[scaling] - min_agents = 1 diff --git a/examples/quickstart/pyproject.toml b/examples/quickstart/pyproject.toml deleted file mode 100644 index efeee9106..000000000 --- a/examples/quickstart/pyproject.toml +++ /dev/null @@ -1,20 +0,0 @@ -[project] -name = "pipecat-quickstart" -version = "0.1.0" -description = "Quickstart example for building voice AI bots with Pipecat" -requires-python = ">=3.10" -dependencies = [ - "pipecat-ai[webrtc,daily,silero,deepgram,openai,cartesia,runner]", - "pipecat-ai-cli" -] - -[dependency-groups] -dev = [ - "pyright>=1.1.404,<2", - "ruff>=0.12.11,<1", -] - -[tool.ruff] -line-length = 100 -[tool.ruff.lint] -select = ["I"]