THIS WORKS

Add create context aggregator

.agents/skills/changelog

@@ -1 +0,0 @@
-../../.claude/skills/changelog

.agents/skills/cleanup

@@ -1 +0,0 @@
-../../.claude/skills/cleanup

.agents/skills/code-review

@@ -1 +0,0 @@
-../../.claude/skills/code-review

.agents/skills/docstring

@@ -1 +0,0 @@
-../../.claude/skills/docstring

.agents/skills/pr-description

@@ -1 +0,0 @@
-../../.claude/skills/pr-description

.agents/skills/pr-submit

@@ -1 +0,0 @@
-../../.claude/skills/pr-submit

.agents/skills/update-docs

@@ -1 +0,0 @@
-../../.claude/skills/update-docs

.claude-plugin/marketplace.json

@@ -1,27 +0,0 @@
-{
-  "name": "pipecat-dev-skills",
-  "owner": {
-    "name": "Pipecat"
-  },
-  "metadata": {
-    "description": "Development workflow skills for contributing to the Pipecat project",
-    "version": "1.0.0"
-  },
-  "plugins": [
-    {
-      "name": "pipecat-dev",
-      "description": "Development workflow skills for contributing to the Pipecat project",
-      "version": "1.0.0",
-      "source": "./",
-      "skills": [
-        "./.claude/skills/changelog",
-        "./.claude/skills/cleanup",
-        "./.claude/skills/code-review",
-        "./.claude/skills/docstring",
-        "./.claude/skills/pr-description",
-        "./.claude/skills/pr-submit",
-        "./.claude/skills/update-docs"
-      ]
-    }
-  ]
-}

.claude/settings.json

@@ -1,5 +0,0 @@
-{
-  "attribution": {
-    "commit": ""
-  }
-}

.claude/skills/changelog/SKILL.md

@@ -1,61 +0,0 @@
----
-name: changelog
-description: Create changelog files for important commits in a PR
----
-
-Create changelog files for the important commits in this PR. The PR number is provided as an argument.
-
-## Instructions
-
-1. Skip changelog for: documentation-only, internal refactoring, test-only, CI changes.
-
-2. First, check what commits are on the current branch compared to main:
-   ```
-   git log main..HEAD --oneline
-   ```
-
-3. For each significant change, create a changelog file in the `changelog/` folder using the format:
-   Allowed types: `added`, `changed`, `deprecated`, `removed`, `fixed`, `security`, `performance`, `other`
-   - `{PR_NUMBER}.added.md` - for new features
-   - `{PR_NUMBER}.added.2.md`, `{PR_NUMBER}.added.3.md` - for additional entries of the same type
-   - `{PR_NUMBER}.changed.md` - for changes to existing functionality
-   - `{PR_NUMBER}.fixed.md` - for bug fixes
-   - `{PR_NUMBER}.deprecated.md` - for deprecations
-   - `{PR_NUMBER}.removed.md` - for removed features
-   - `{PR_NUMBER}.security.md` - for security fixes
-   - `{PR_NUMBER}.performance.md` - for performance improvements
-   - `{PR_NUMBER}.other.md` - for other changes
-
-4. Each changelog file should at least contain a main single line starting with `- ` followed by a clear description of the change. No line wrapping.
-
-5. If the change is complicated, changelog files can have indented lines after the main line with additional details or code samples.
-
-6. Use ⚠️ emoji prefix for breaking changes.
-
-7. **Write changes in user-facing terms first.** Lead with what users of the framework will notice: new APIs, changed behavior, new parameters, fixed bugs they might have hit, etc. Implementation details (internal refactoring, how something is wired up under the hood) can be included as secondary context after the user-facing description, but should never be the *only* content of a changelog entry when there is a user-visible effect.
-
-   **Good** (user-facing first, implementation detail as context):
-   ```
-   - Turn completion instructions now persist correctly across full context updates when using `system_instruction`. Previously they were injected as a context system message, which caused warning spam and didn't survive context updates.
-   ```
-
-   **Bad** (implementation detail only, no user-facing framing):
-   ```
-   - Fixed turn completion instructions being injected as a context system message instead of using `system_instruction`.
-   ```
-
-   Ask yourself: "If I'm a developer building on Pipecat, what would I notice changed?" Start there.
-
-## Example
-
-For PR #3519 with a new feature and a bug fix:
-
-`changelog/3519.added.md`:
-```
-- Added `SomeNewFeature` for doing something useful.
-```
-
-`changelog/3519.fixed.md`:
-```
-- Fixed an issue where something was not working correctly in some user-visible scenario. The root cause was an internal implementation detail.
-```

.claude/skills/cleanup/SKILL.md

@@ -1,312 +0,0 @@
----
-name: cleanup
-description: Review, refactor, document, and validate code changes in the current branch
----
-
-# Code Cleanup Skill
-
-The **Code Cleanup Skill** reviews, refactors, and documents code changes in your current branch, ensuring alignment with **Pipecat's architecture, coding standards, and example patterns**.
-It focuses on **readability, correctness, performance, and consistency**, while avoiding breaking changes.
-
----
-
-## Skill Overview
-
-This skill analyzes all changes introduced in your branch and performs the following actions:
-
-1. **Analyze Branch Changes**
-   - Review uncommitted changes and outgoing commits
-2. **Refactor for Readability**
-   - Improve clarity, naming, structure, and modern Python usage
-3. **Enhance Performance**
-   - Identify safe, conservative optimization opportunities
-4. **Add Documentation**
-   - Apply Pipecat-style, Google-format docstrings
-5. **Ensure Pattern Consistency**
-   - Match existing Pipecat services, pipelines, and examples
-6. **Validate Examples**
-   - Ensure examples follow foundational patterns (e.g. `07-interruptible.py`)
-
----
-
-## Usage
-
-Invoke the skill using any of the following commands:
-
-- "Clean up my branch code"
-- "Refactor the changes in my branch"
-- "Review and improve my branch code"
-- `/cleanup`
-
----
-
-## What This Skill Does
-
-### 1. Analyze Branch Changes
-
-The skill retrieves all uncommitted changes and outgoing commits to understand:
-
-- New files added
-- Modified files
-- Code additions and deletions
-- Overall scope and intent of changes
-
----
-
-### 2. Code Refactoring
-
-#### Readability Improvements
-
-- Replace tuples with named classes or dataclasses
-- Improve variable, method, and class naming
-- Extract complex logic into well-named helper methods
-- Add missing type hints
-- Simplify nested or complex conditionals
-- Replace deprecated methods and features
-- Normalize formatting to match Pipecat style
-
-#### Performance Enhancements
-
-- Identify inefficient loops or repeated work
-- Suggest appropriate data structures
-- Optimize async workflows and I/O
-- Remove redundant operations
-
-> Performance changes are conservative and non-breaking.
-
----
-
-### 3. Documentation
-
-Documentation follows **Google-style docstrings**, consistent with Pipecat conventions.
-
-#### Class Documentation
-
-```python
-class ExampleService:
-    """Brief one-line description.
-
-    Detailed explanation of the class purpose, responsibilities,
-    and important behaviors.
-
-    Supported features:
-
-    - Feature 1
-    - Feature 2
-    - Feature 3
-    """
-```
-
-#### Method Documentation
-
-```python
-def process_data(self, data: str, options: Optional[dict] = None) -> bool:
-    """Process incoming data with optional configuration.
-
-    Args:
-        data: The input data to process.
-        options: Optional configuration dictionary.
-
-    Returns:
-        True if processing succeeded, False otherwise.
-
-    Raises:
-        ValueError: If data is empty or invalid.
-    """
-```
-
-#### Pydantic Model Parameters
-
-```python
-class InputParams(BaseModel):
-    """Configuration parameters for the service.
-
-    Parameters:
-        timeout: Request timeout in seconds.
-        retry_count: Number of retry attempts.
-        enable_logging: Whether to enable debug logging.
-    """
-
-    timeout: Optional[float] = None
-    retry_count: int = 3
-    enable_logging: bool = False
-```
-
----
-
-### 4. Pattern Consistency Checks
-
-#### Service Classes
-
-- Correct inheritance (`TTSService`, `STTService`, `LLMService`)
-- Consistent constructor signatures
-- Frame emission patterns
-- Metrics support:
-  - `can_generate_metrics()`
-  - TTFB metrics
-  - Usage metrics
-- Alignment with similar existing services
-
-#### Examples
-
-Validated against `examples/07-interruptible.py`:
-
-- Proper `create_transport()` usage
-- Correct pipeline structure
-- Task setup and observers
-- Event handler registration
-- Runner and bot entrypoint consistency
-
----
-
-### 5. Specific Implementation Patterns
-
-#### Service Implementation
-
-```python
-class ExampleTTSService(TTSService):
-
-    def __init__(self, *, api_key: Optional[str] = None, **kwargs):
-        super().__init__(**kwargs)
-        self._api_key = api_key or os.getenv("SERVICE_API_KEY")
-
-    def can_generate_metrics(self) -> bool:
-        return True
-
-    async def run_tts(self, text: str) -> AsyncGenerator[Frame, None]:
-        try:
-            await self.start_ttfb_metrics()
-            yield TTSStartedFrame()
-            # ... processing ...
-            yield TTSAudioRawFrame(...)
-        finally:
-            await self.stop_ttfb_metrics()
-```
-
----
-
-#### Example Structure Pattern
-
-```python
-transport_params = {
-    "daily": lambda: DailyParams(...),
-    "twilio": lambda: FastAPIWebsocketParams(...),
-    "webrtc": lambda: TransportParams(...),
-}
-
-async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
-    stt = DeepgramSTTService(...)
-    tts = SomeTTSService(...)
-    llm = OpenAILLMService(...)
-
-    context = LLMContext(messages)
-    user_aggregator, assistant_aggregator = LLMContextAggregatorPair(...)
-
-    pipeline = Pipeline([...])
-    task = PipelineTask(pipeline, params=..., observers=[...])
-
-    @transport.event_handler("on_client_connected")
-    async def on_client_connected(transport, client):
-        await task.queue_frames([LLMRunFrame()])
-
-    runner = PipelineRunner(handle_sigint=runner_args.handle_sigint)
-    await runner.run(task)
-
-async def bot(runner_args: RunnerArguments):
-    """Main bot entry point compatible with Pipecat Cloud."""
-    transport = await create_transport(runner_args, transport_params)
-    await run_bot(transport, runner_args)
-```
-
----
-
-## Execution Flow
-
-1. Fetch uncommitted and outgoing changes
-2. Categorize files (services, examples, tests, utilities)
-3. Analyze each file:
-   - Readability
-   - Performance
-   - Documentation
-   - Pattern consistency
-4. Generate actionable recommendations
-5. Apply Pipecat standards
-
----
-
-## Examples
-
-### Before: Tuple Usage
-
-```python
-def get_audio_info(self) -> Tuple[int, int]:
-    return (48000, 1)
-```
-
-### After: Named Class
-
-```python
-class AudioInfo:
-    """Audio configuration information.
-
-    Parameters:
-        sample_rate: Sample rate in Hz.
-        num_channels: Number of audio channels.
-    """
-
-    sample_rate: int
-    num_channels: int
-
-def get_audio_info(self) -> AudioInfo:
-    return AudioInfo(sample_rate=48000, num_channels=1)
-```
-
----
-
-### Before: Missing Documentation
-
-```python
-class NewTTSService(TTSService):
-    def __init__(self, api_key: str, voice: str):
-        self._api_key = api_key
-        self._voice = voice
-```
-
-### After: Fully Documented
-
-```python
-class NewTTSService(TTSService):
-    """Text-to-speech service using NewProvider API.
-
-    Streams PCM audio and emits TTSAudioRawFrame frames compatible
-    with Pipecat transports.
-
-    Supported features:
-    - Text-to-speech synthesis
-    - Streaming PCM audio
-    - Voice customization
-    - TTFB metrics
-    """
-
-    def __init__(self, *, api_key: str, voice: str, **kwargs):
-        """Initialize the NewTTSService.
-
-        Args:
-            api_key: API key for authentication.
-            voice: Voice identifier to use.
-            **kwargs: Additional arguments passed to the parent service.
-        """
-        super().__init__(**kwargs)
-        self._api_key = api_key
-        self.set_voice(voice)
-```
-
----
-
-## Notes
-
-- Non-breaking improvements only
-- Backward compatibility preserved
-- Conservative performance changes
-- Google-style docstrings
-- Pattern checks follow recent Pipecat code

.claude/skills/code-review/SKILL.md

@@ -1,107 +0,0 @@
----
-name: code-review
-description: Automated code review for pull requests using multiple specialized agents
-disable-model-invocation: true
-allowed-tools: Bash(gh issue view:*), Bash(gh search:*), Bash(gh issue list:*), Bash(gh pr comment:*), Bash(gh pr diff:*), Bash(gh pr view:*), Bash(gh pr list:*)
----
-
-Provide a code review for the given pull request.
-
-**Agent assumptions (applies to all agents and subagents):**
-
-- All tools are functional and will work without error. Do not test tools or make exploratory calls. Make sure this is clear to every subagent that is launched.
-- Only call a tool if it is required to complete the task. Every tool call should have a clear purpose.
-
-To do this, follow these steps precisely:
-
-1. Launch a haiku agent to check if any of the following are true:
-   - The pull request is closed
-   - The pull request is a draft
-   - The pull request does not need code review (e.g. automated PR, trivial change that is obviously correct)
-   - Claude has already commented on this PR (check `gh pr view <PR> --comments` for comments left by claude)
-
-   If any condition is true, stop and do not proceed.
-
-Note: Still review Claude generated PR's.
-
-2. Launch a haiku agent to return a list of file paths (not their contents) for all relevant CLAUDE.md files including:
-   - The root CLAUDE.md file, if it exists
-   - Any CLAUDE.md files in directories containing files modified by the pull request
-
-3. Launch a sonnet agent to view the pull request and return a summary of the changes
-
-4. Launch 4 agents in parallel to independently review the changes. Each agent should return the list of issues, where each issue includes a description and the reason it was flagged (e.g. "CLAUDE.md adherence", "bug"). The agents should do the following:
-
-   Agents 1 + 2: CLAUDE.md compliance sonnet agents
-   Audit changes for CLAUDE.md compliance in parallel. Note: When evaluating CLAUDE.md compliance for a file, you should only consider CLAUDE.md files that share a file path with the file or parents.
-
-   Agent 3: Opus bug agent (parallel subagent with agent 4)
-   Scan for obvious bugs. Focus only on the diff itself without reading extra context. Flag only significant bugs; ignore nitpicks and likely false positives. Do not flag issues that you cannot validate without looking at context outside of the git diff.
-
-   Agent 4: Opus bug agent (parallel subagent with agent 3)
-   Look for problems that exist in the introduced code. This could be security issues, incorrect logic, etc. Only look for issues that fall within the changed code.
-
-   **CRITICAL: We only want HIGH SIGNAL issues.** Flag issues where:
-   - The code will fail to compile or parse (syntax errors, type errors, missing imports, unresolved references)
-   - The code will definitely produce wrong results regardless of inputs (clear logic errors)
-   - Clear, unambiguous CLAUDE.md violations where you can quote the exact rule being broken
-
-   Do NOT flag:
-   - Code style or quality concerns
-   - Potential issues that depend on specific inputs or state
-   - Subjective suggestions or improvements
-
-   If you are not certain an issue is real, do not flag it. False positives erode trust and waste reviewer time.
-
-   In addition to the above, each subagent should be told the PR title and description. This will help provide context regarding the author's intent.
-
-5. For each issue found in the previous step by agents 3 and 4, launch parallel subagents to validate the issue. These subagents should get the PR title and description along with a description of the issue. The agent's job is to review the issue to validate that the stated issue is truly an issue with high confidence. For example, if an issue such as "variable is not defined" was flagged, the subagent's job would be to validate that is actually true in the code. Another example would be CLAUDE.md issues. The agent should validate that the CLAUDE.md rule that was violated is scoped for this file and is actually violated. Use Opus subagents for bugs and logic issues, and sonnet agents for CLAUDE.md violations.
-
-6. Filter out any issues that were not validated in step 5. This step will give us our list of high signal issues for our review.
-
-7. If issues were found, skip to step 8 to post comments.
-
-   If NO issues were found, post a summary comment using `gh pr comment` (if `--comment` argument is provided):
-   "No issues found. Checked for bugs and CLAUDE.md compliance."
-
-8. Create a list of all comments that you plan on leaving. This is only for you to make sure you are comfortable with the comments. Do not post this list anywhere.
-
-9. Post inline comments for each issue using `gh pr review` with inline comments. For each comment:
-   - Provide a brief description of the issue
-   - For small, self-contained fixes, include a committable suggestion block
-   - For larger fixes (6+ lines, structural changes, or changes spanning multiple locations), describe the issue and suggested fix without a suggestion block
-   - Never post a committable suggestion UNLESS committing the suggestion fixes the issue entirely. If follow up steps are required, do not leave a committable suggestion.
-
-   **IMPORTANT: Only post ONE comment per unique issue. Do not post duplicate comments.**
-
-Use this list when evaluating issues in Steps 4 and 5 (these are false positives, do NOT flag):
-
-- Pre-existing issues
-- Something that appears to be a bug but is actually correct
-- Pedantic nitpicks that a senior engineer would not flag
-- Issues that a linter will catch (do not run the linter to verify)
-- General code quality concerns (e.g., lack of test coverage, general security issues) unless explicitly required in CLAUDE.md
-- Issues mentioned in CLAUDE.md but explicitly silenced in the code (e.g., via a lint ignore comment)
-
-Notes:
-
-- Use gh CLI to interact with GitHub (e.g., fetch pull requests, create comments). Do not use web fetch.
-- Create a todo list before starting.
-- You must cite and link each issue in inline comments (e.g., if referring to a CLAUDE.md, include a link to it).
-- If no issues are found, post a comment with the following format:
-
----
-
-## Code review
-
-No issues found. Checked for bugs and CLAUDE.md compliance.
-
----
-
-- When linking to code in inline comments, follow the following format precisely, otherwise the Markdown preview won't render correctly: `https://github.com/OWNER/REPO/blob/FULL_SHA/path/to/file.py#L10-L15`
-  - Requires full git sha
-  - You must provide the full sha. Commands like `https://github.com/owner/repo/blob/$(git rev-parse HEAD)/foo/bar` will not work, since your comment will be directly rendered in Markdown.
-  - Repo name must match the repo you're code reviewing
-  - # sign after the file name
-  - Line range format is L[start]-L[end]
-  - Provide at least 1 line of context before and after, centered on the line you are commenting about (eg. if you are commenting about lines 5-6, you should link to `L4-7`)

.claude/skills/docstring/SKILL.md

@@ -1,256 +0,0 @@
----
-name: docstring
-description: Document a Python module and its classes using Google style
----
-
-Document a Python module or class using Google-style docstrings following project conventions. The argument can be a class name or a module path.
-
-## Instructions
-
-1. Determine what to document based on the argument:
-
-   **If a module path is provided** (e.g. `src/pipecat/audio/vad/vad_analyzer.py`):
-   - Use that file directly
-
-   **If a class name is provided** (e.g. `VADAnalyzer`):
-   - Search for `class ClassName` in `src/pipecat/`
-   - If multiple files contain that class name, list all matches with their file paths, ask the user which one they want to document, and wait for confirmation
-
-2. Once the file is identified, read the module to understand its structure:
-   - Identify all classes, functions, and important type aliases
-   - Understand the purpose of each component
-
-4. Apply documentation in this order:
-   - Module docstring (at top, after imports)
-   - Class docstrings
-   - `__init__` methods (always document constructor parameters)
-   - Public methods (not starting with `_`)
-   - Dataclass/config classes with field descriptions
-
-5. Skip documentation for:
-   - Private methods (starting with `_`)
-   - Simple dunder methods (`__str__`, `__repr__`, `__post_init__`)
-   - Very simple pass-through properties
-   - **Already documented code** - If a class, method, or function already has a complete docstring that follows the project style, do not modify it. A docstring is complete if it has:
-     - A one-line summary
-     - Args section (if it has parameters)
-     - Returns section (if it returns something meaningful)
-   - Only add or improve documentation where it is missing or incomplete
-
-## Module Docstring Format
-
-```python
-"""[One-line description of module purpose].
-
-[Optional: Longer explanation of functionality, key classes, or use cases.]
-"""
-```
-
-Example:
-```python
-"""Neuphonic text-to-speech service implementations.
-
-This module provides WebSocket and HTTP-based integrations with Neuphonic's
-text-to-speech API for real-time audio synthesis.
-"""
-```
-
-## Class Docstring Format
-
-```python
-class ClassName:
-    """One-line summary describing what the class does.
-
-    [Longer description explaining purpose, behavior, and key features.
-    Use action-oriented language.]
-
-    [Optional: Event handlers, usage notes, or important caveats.]
-    """
-```
-
-Example:
-```python
-class FrameProcessor(BaseObject):
-    """Base class for all frame processors in the pipeline.
-
-    Frame processors are the building blocks of Pipecat pipelines, they can be
-    linked to form complex processing pipelines. They receive frames, process
-    them, and pass them to the next or previous processor in the chain.
-
-    Event handlers available:
-
-    - on_before_process_frame: Called before a frame is processed
-    - on_after_process_frame: Called after a frame is processed
-
-    Example::
-
-        @processor.event_handler("on_before_process_frame")
-        async def on_before_process_frame(processor, frame):
-            ...
-
-        @processor.event_handler("on_after_process_frame")
-        async def on_after_process_frame(processor, frame):
-            ...
-    """
-```
-
-Note: When listing event handlers, do NOT use backticks. Include an `Example::` section (with double colon for Sphinx) showing the decorator pattern and function signature for each event.
-
-## Constructor (`__init__`) Format
-
-```python
-def __init__(self, *, param1: Type, param2: Type = default, **kwargs):
-    """Initialize the [ClassName].
-
-    Args:
-        param1: Description of param1 and its purpose.
-        param2: Description of param2. Defaults to [default].
-        **kwargs: Additional arguments passed to parent class.
-    """
-```
-
-Example:
-```python
-def __init__(
-    self,
-    *,
-    api_key: str,
-    voice_id: Optional[str] = None,
-    sample_rate: Optional[int] = 22050,
-    **kwargs,
-):
-    """Initialize the Neuphonic TTS service.
-
-    Args:
-        api_key: Neuphonic API key for authentication.
-        voice_id: ID of the voice to use for synthesis.
-        sample_rate: Audio sample rate in Hz. Defaults to 22050.
-        **kwargs: Additional arguments passed to parent InterruptibleTTSService.
-    """
-```
-
-## Method Docstring Format
-
-```python
-async def method_name(self, param1: Type) -> ReturnType:
-    """One-line summary of what method does.
-
-    [Longer description if behavior isn't obvious.]
-
-    Args:
-        param1: Description of param1.
-
-    Returns:
-        Description of return value.
-
-    Raises:
-        ExceptionType: When this exception is raised.
-    """
-```
-
-Example:
-```python
-async def put(self, item: Tuple[Frame, FrameDirection, FrameCallback]):
-    """Put an item into the priority queue.
-
-    System frames (`SystemFrame`) have higher priority than any other
-    frames. If a non-frame item is provided it will have the highest priority.
-
-    Args:
-        item: The item to enqueue.
-    """
-```
-
-## Dataclass/Config Format
-
-```python
-@dataclass
-class ConfigName:
-    """One-line description of configuration.
-
-    [Explanation of when/how to use this config.]
-
-    Parameters:
-        field1: Description of field1.
-        field2: Description of field2. Defaults to [default].
-    """
-
-    field1: Type
-    field2: Type = default_value
-```
-
-Example:
-```python
-@dataclass
-class FrameProcessorSetup:
-    """Configuration parameters for frame processor initialization.
-
-    Parameters:
-        clock: The clock instance for timing operations.
-        task_manager: The task manager for handling async operations.
-        observer: Optional observer for monitoring frame processing events.
-    """
-
-    clock: BaseClock
-    task_manager: BaseTaskManager
-    observer: Optional[BaseObserver] = None
-```
-
-## Enum Documentation Format
-
-```python
-class EnumName(Enum):
-    """One-line description of the enum purpose.
-
-    [Longer description of how the enum is used.]
-
-    Parameters:
-        VALUE1: Description of VALUE1.
-        VALUE2: Description of VALUE2.
-    """
-
-    VALUE1 = 1
-    VALUE2 = 2
-```
-
-## Writing Style Guidelines
-
-- **Concise and professional** - No casual language or filler words
-- **Action-oriented** - Start with verbs: "Processes...", "Manages...", "Converts..."
-- **Purpose before implementation** - Explain WHY before HOW
-- **Clear parameter descriptions** - Include type hints, defaults, and purpose
-- **No redundant type info** - Type hints are in the signature, don't repeat in description
-- **Use backticks for code references** - Wrap class names, method names, event names, parameter names, and code snippets in backticks
-
-Good: "Neuphonic API key for authentication."
-Bad: "str: The API key (string) that is used for authenticating with Neuphonic."
-
-Good: "Triggers `on_speech_started` when the `VADAnalyzer` detects speech."
-Bad: "Triggers on_speech_started when the VADAnalyzer detects speech."
-
-## Deprecation Notice Format
-
-When documenting deprecated code:
-
-```python
-"""[Description].
-
-.. deprecated:: X.X.X
-    `ClassName` is deprecated and will be removed in a future version.
-    Use `NewClassName` instead.
-"""
-```
-
-## Checklist
-
-Before finishing, verify:
-
-- [ ] Module has a docstring at the top (after copyright header and imports)
-- [ ] All public classes have docstrings
-- [ ] All `__init__` methods document their parameters
-- [ ] All public methods have docstrings with Args/Returns/Raises as needed
-- [ ] Dataclasses use "Parameters:" section for field descriptions
-- [ ] Enums document each value in "Parameters:" section
-- [ ] Writing is concise and action-oriented
-- [ ] No documentation added to private methods (starting with `_`)
-- [ ] Existing complete docstrings were left unchanged

.claude/skills/pr-description/SKILL.md

@@ -1,128 +0,0 @@
----
-name: pr-description
-description: Update a GitHub PR description with a summary of changes
----
-
-Update a GitHub pull request description based on the changes in the PR.
-
-## Arguments
-
-```
-/pr-description <PR_NUMBER> [--fixes <ISSUE_NUMBERS>]
-```
-
-- `PR_NUMBER` (required): The pull request number to update
-- `--fixes` (optional): Comma-separated issue numbers that this PR fixes (e.g., `--fixes 123,456`)
-
-Examples:
-- `/pr-description 3534`
-- `/pr-description 3534 --fixes 123`
-- `/pr-description 3534 --fixes 123,456,789`
-
-## Instructions
-
-1. First, gather information about the PR:
-   - Use GitHub plugin to get PR details (title, current description, base branch)
-   - Use local git to get commits: `git log main..HEAD --oneline`
-   - Use local git to get the diff: `git diff main..HEAD`
-   - Parse any `--fixes` argument for issue numbers
-
-2. Check the existing PR description:
-   - If it already has a complete, accurate description that reflects the changes, do nothing
-   - If it's missing sections, incomplete, or outdated compared to the actual changes, proceed to update
-   - If it only has the template placeholder text, generate a full description
-
-3. Analyze the changes:
-   - Understand the purpose of each commit
-   - Identify any breaking changes (API changes, removed features, behavior changes)
-   - Look for new features, bug fixes, refactoring, or documentation changes
-   - Collect issue numbers from:
-     - The `--fixes` argument (if provided)
-     - Commit messages (patterns like "Fixes #123", "Closes #456", "Resolves #789")
-
-4. Generate or update the PR description with these sections:
-
-## PR Description Format
-
-### Summary (always include)
-
-Brief bullet points describing what changed and why. Focus on the *purpose* and *impact*, not implementation details.
-
-```markdown
-## Summary
-
-- Added X to enable Y
-- Fixed bug where Z would happen
-- Refactored W for better maintainability
-```
-
-### Breaking Changes (include only if applicable)
-
-Document any changes that affect existing users or APIs.
-
-```markdown
-## Breaking Changes
-
-- `ClassName.method()` now requires a `param` argument
-- Removed deprecated `old_function()` - use `new_function()` instead
-```
-
-### Testing (include when non-obvious)
-
-How to verify the changes work. Skip for trivial changes.
-
-```markdown
-## Testing
-
-- Run `uv run pytest tests/test_feature.py` to verify the fix
-- Example usage: `uv run examples/new_feature.py`
-```
-
-### Fixes (include if issues are provided or found in commits)
-
-List issues this PR fixes. GitHub will automatically close these issues when the PR is merged.
-
-```markdown
-## Fixes
-
-- Fixes #123
-- Fixes #456
-```
-
-Note: Use "Fixes #X" format (not "Closes" or "Resolves") for consistency. Each issue should be on its own line with "Fixes" to ensure GitHub auto-closes them.
-
-## Guidelines
-
-- **Be concise** - Reviewers should understand the PR in 30 seconds
-- **Focus on why** - The diff shows *what* changed, explain *why*
-- **Skip empty sections** - Only include sections that have content
-- **Use bullet points** - Easier to scan than paragraphs
-- **Don't duplicate the diff** - Avoid listing every file or line changed
-
-## Example Output
-
-```markdown
-## Summary
-
-- Added `/docstring` skill for documenting Python modules with Google-style docstrings
-- Skill finds classes by name and handles conflicts when multiple matches exist
-- Skips already-documented code to avoid unnecessary changes
-
-## Testing
-
-/docstring ClassName
-
-## Fixes
-
-- Fixes #123
-```
-
-## Checklist
-
-Before updating the PR:
-
-- [ ] Verified existing description needs updating (not already complete)
-- [ ] Summary accurately reflects the changes
-- [ ] Breaking changes are clearly documented (if any)
-- [ ] No unnecessary sections included
-- [ ] Description is concise and scannable

.claude/skills/pr-submit/SKILL.md

@@ -1,28 +0,0 @@
----
-name: pr-submit
-description: Create and submit a GitHub PR from the current branch
----
-
-Submit the current changes as a GitHub pull request.
-
-## Instructions
-
-1. Check the current state of the repository:
-   - Run `git status` to see staged, unstaged, and untracked changes
-   - Run `git diff` to see current changes
-   - Run `git log --oneline -10` to see recent commits
-
-2. If there are uncommitted changes relevant to the PR:
-   - Ask the user if they want a specific prefix for the branch name (e.g., `alice/`, `fix/`, `feat/`)
-   - Create a new branch based on the current branch
-   - Commit the changes using multiple commits if the changes are unrelated
-
-3. Push the branch and create the PR:
-   - Push with `-u` flag to set upstream tracking
-   - Create the PR using `gh pr create`
-
-4. After the PR is created:
-   - Run `/changelog <pr_number>` to generate changelog files, then commit and push them
-   - Run `/pr-description <pr_number>` to update the PR description
-
-5. Return the PR URL to the user.

.claude/skills/update-docs/SKILL.md

@@ -1,306 +0,0 @@
----
-name: update-docs
-description: Update documentation pages to match source code changes on the current branch
----
-
-Update documentation pages to reflect source code changes on the current branch. Analyzes the diff against main, maps changed source files to their corresponding doc pages, and makes targeted edits.
-
-## Arguments
-
-```
-/update-docs [DOCS_PATH]
-```
-
-- `DOCS_PATH` (optional): Path to the docs repository root. If not provided, ask the user.
-
-Examples:
-- `/update-docs /Users/me/src/docs`
-- `/update-docs`
-
-## Instructions
-
-### Step 1: Resolve docs path
-
-If `DOCS_PATH` was provided as an argument, use it. Otherwise, ask the user for the path to their docs repository.
-
-Verify the path exists and contains `server/services/` subdirectory.
-
-### Step 2: Create docs branch
-
-Get the current pipecat branch name:
-```bash
-git rev-parse --abbrev-ref HEAD
-```
-
-In the docs repo, create a new branch off main with a matching name:
-```bash
-cd DOCS_PATH && git checkout main && git pull && git checkout -b {branch-name}-docs
-```
-
-For example, if the pipecat branch is `feat/new-service`, the docs branch becomes `feat/new-service-docs`.
-
-All doc edits in subsequent steps are made on this branch.
-
-### Step 3: Detect changed source files
-
-Run:
-```bash
-git diff main..HEAD --name-only
-```
-
-Filter to files that could affect documentation:
-- `src/pipecat/services/**/*.py` (service implementations)
-- `src/pipecat/transports/**/*.py` (transport implementations)
-- `src/pipecat/serializers/**/*.py` (serializer implementations)
-- `src/pipecat/processors/**/*.py` (processor implementations)
-- `src/pipecat/audio/**/*.py` (audio utilities)
-- `src/pipecat/turns/**/*.py` (turn management)
-- `src/pipecat/observers/**/*.py` (observers)
-- `src/pipecat/pipeline/**/*.py` (pipeline core)
-
-Ignore `__init__.py`, `__pycache__`, test files, and files that only contain type re-exports.
-
-### Step 4: Map source files to doc pages
-
-For each changed source file, find the corresponding doc page. Read the mapping file at `.claude/skills/update-docs/SOURCE_DOC_MAPPING.md` and apply its tiered lookup: tier 1 (known exceptions) → tier 2 (pattern matching) → tier 3 (search fallback). **First match wins.**
-
-### Step 5: Analyze each source-doc pair
-
-For each mapped pair:
-
-1. **Read the full source file** to understand current state
-2. **Read the diff** for that file: `git diff main..HEAD -- <source_file>`
-3. **Read the current doc page** in full
-
-Identify what changed by comparing source to docs:
-
-- **Constructor parameters**: Compare `__init__` signature to the Configuration section's `<ParamField>` entries
-- **InputParams fields**: Compare `InputParams(BaseModel)` class fields to the InputParams table
-- **Event handlers**: Compare `_register_event_handler` calls and event handler definitions to Event Handlers section
-- **Class names / imports**: Check if Usage examples reference correct names
-- **Behavioral changes**: Check if Notes section needs updating
-
-### Step 6: Make targeted edits
-
-For each doc page that needs updates, edit **only the sections that need changes**. Preserve all other content exactly as-is.
-
-#### Rules
-
-- **Never remove content** unless the corresponding source code was removed
-- **Never rewrite sections** that are already accurate
-- **Match existing formatting** — if the page uses `<ParamField>` tags, use them; if it uses tables, use tables
-- **Keep descriptions concise** — match the tone and length of surrounding content
-- **Preserve CardGroup, links, and examples** unless they reference removed functionality
-- **Don't touch frontmatter** unless the class was renamed
-
-#### Section-specific guidance
-
-**Configuration** (constructor params):
-- Use `<ParamField path="name" type="type" default="value">` format if the page already uses it
-- Add new params in logical order (required first, then optional)
-- Remove params that no longer exist in source
-- Update types/defaults that changed
-
-**InputParams** (runtime settings):
-- Use markdown table format: `| Parameter | Type | Default | Description |`
-- Match the field names and types from the `InputParams(BaseModel)` class
-- Include the default values from the source
-
-**Usage** (code examples):
-- Update import paths, class names, and parameter names
-- Only modify examples if they would break or be misleading with the new API
-- Don't rewrite working examples just to add new optional params
-
-**Notes**:
-- Add notes for new behavioral gotchas or breaking changes
-- Remove notes about limitations that were fixed
-- Keep existing notes that are still accurate
-
-**Event Handlers**:
-- Update the event table and example code
-- Add new events, remove deleted ones
-- Update handler signatures if they changed
-
-**Overview / Key Features / Prerequisites**:
-- Only update if the PR fundamentally changes what the service does (new capability, removed capability, renamed class)
-- Most PRs will NOT need changes to these sections
-
-### Step 7: Update guides
-
-Guides at `DOCS_PATH/guides/` reference specific class names, parameters, imports, and code patterns. After completing reference doc edits, check if any guides need updates too.
-
-For each changed source file, collect the class names, renamed parameters, and changed imports from the diff. Search the guides directory:
-```bash
-grep -rl "ClassName\|old_param_name" DOCS_PATH/guides/
-```
-
-For each guide that references changed code:
-1. Read the full guide
-2. Update class names, parameter names, import paths, and code examples that are now incorrect
-3. **Don't rewrite prose** — only fix the specific references that changed
-4. Leave guides alone if they reference the service generally but don't use any changed APIs
-
-Guide directories:
-- `guides/learn/` — conceptual tutorials (pipeline, LLM, STT, TTS, etc.)
-- `guides/fundamentals/` — practical how-tos (metrics, recording, transcripts, etc.)
-- `guides/features/` — feature-specific guides (Gemini Live, OpenAI audio, WhatsApp, etc.)
-- `guides/telephony/` — telephony integration guides (Twilio, Plivo, Telnyx, etc.)
-
-### Step 8: Identify doc gaps
-
-After processing all mapped pairs, check for two kinds of gaps:
-
-**Missing pages**: Source files that had no doc page mapping (neither tier 1, 2, nor 3) and are not marked as "(skip)". For each, tell the user:
-- The source file path
-- The main class(es) it defines
-- Whether a new doc page should be created
-
-**Missing sections**: Mapped doc pages that are missing standard sections compared to the source. For example, a transport page with no Configuration section, or a service page with no InputParams table when the source defines `InputParams(BaseModel)`. Flag these and offer to add the missing sections.
-
-If the user wants a new page, do all three of the following:
-
-#### 8a: Create the doc page
-
-Create the new `.mdx` file using this template structure:
-```
----
-title: "Service Name"
-description: "Brief description"
----
-
-## Overview
-
-[Description from class docstring or source analysis]
-
-<CardGroup cols={2}>
-  [Cards for API reference and examples if available]
-</CardGroup>
-
-## Installation
-
-```bash
-pip install "pipecat-ai[package-name]"
-```
-
-## Prerequisites
-
-[Environment variables and account setup]
-
-## Configuration
-
-[ParamField entries for constructor params]
-
-## InputParams
-
-[Table of InputParams fields, if the service has them]
-
-## Usage
-
-### Basic Setup
-
-```python
-[Minimal working example]
-```
-
-## Notes
-
-[Important caveats]
-
-## Event Handlers
-
-[Event table and example code]
-```
-
-#### 8b: Add to docs.json
-
-Add the new page path to `DOCS_PATH/docs.json` in the correct navigation group. The path format is `server/services/{category}/{provider}` (without the `.mdx` extension).
-
-Find the matching group in the navigation structure:
-- **STT** → `"group": "Speech-to-Text"` under Services
-- **TTS** → `"group": "Text-to-Speech"` under Services
-- **LLM** → `"group": "LLM"` under Services
-- **S2S** → `"group": "Speech-to-Speech"` under Services
-- **Transport** → `"group": "Transport"` under Services
-- **Serializer** → `"group": "Serializers"` under Services
-- **Image generation** → `"group": "Image Generation"` under Services
-- **Video** → `"group": "Video"` under Services
-- **Memory** → `"group": "Memory"` under Services
-- **Vision** → `"group": "Vision"` under Services
-- **Analytics** → `"group": "Analytics & Monitoring"` under Services
-
-Insert the new entry **alphabetically** within the group's `pages` array. For example, adding a new STT service "foo":
-```json
-{
-  "group": "Speech-to-Text",
-  "pages": [
-    "server/services/stt/assemblyai",
-    "server/services/stt/aws",
-    ...
-    "server/services/stt/foo",
-    ...
-  ]
-}
-```
-
-#### 8c: Add to supported-services.mdx
-
-Add a new row to the correct category table in `DOCS_PATH/server/services/supported-services.mdx`.
-
-Use this format:
-```
-| [DisplayName](/server/services/{category}/{provider}) | `pip install "pipecat-ai[package]"` |
-```
-
-To determine the correct values:
-- **DisplayName**: Use the service's human-readable name (e.g., "ElevenLabs", "AWS Polly", "Google Gemini")
-- **package**: Look at the service's `pyproject.toml` extras or the import pattern in the source code. For example, if the service is in `src/pipecat/services/foo/`, the package is typically `foo`.
-- If no pip dependencies are required, use `No dependencies required` instead.
-
-Insert the new row **alphabetically** within the table. Match the column alignment of the existing rows.
-
-### Step 9: Output summary
-
-After all edits are complete, print a summary:
-
-```
-## Documentation Updates
-
-### Updated reference pages
-- `server/services/stt/deepgram.mdx` — Updated Configuration (added `new_param`), InputParams (updated `language` default)
-- `server/services/tts/elevenlabs.mdx` — Updated Event Handlers (added `on_connected`)
-
-### Updated guides
-- `guides/learn/speech-to-text.mdx` — Updated code example (renamed `old_param` → `new_param`)
-
-### New service pages
-- `server/services/tts/newprovider.mdx` — Created page, added to docs.json (Text-to-Speech), added to supported-services.mdx
-
-### Unmapped source files
-- `src/pipecat/services/newprovider/tts.py` — NewProviderTTSService (no doc page exists)
-
-### Skipped files
-- `src/pipecat/services/ai_service.py` — internal base class
-```
-
-## Guidelines
-
-- **Be conservative** — only change what the diff warrants. Don't "improve" docs beyond what changed in source.
-- **Read before editing** — always read the full doc page before making changes so you understand the existing structure.
-- **Preserve voice** — match the writing style of the existing doc page, don't impose a different tone.
-- **One PR at a time** — this skill operates on the current branch's diff against main. Don't look at other branches.
-- **Parallel analysis** — when multiple source files map to different doc pages, analyze and edit them in parallel for efficiency.
-- **Shared source files** — files like `services/google/google.py` are shared bases. Check which services import from them and update all affected doc pages.
-
-## Checklist
-
-Before finishing, verify:
-
-- [ ] All changed source files were checked against the mapping table
-- [ ] Each doc page edit matches the actual source code change (not guessed)
-- [ ] No content was removed unless the corresponding source was removed
-- [ ] New parameters have accurate types and defaults from source
-- [ ] Formatting matches the existing page style
-- [ ] Guides referencing changed APIs were checked and updated
-- [ ] New service pages were added to `docs.json` in the correct group, alphabetically
-- [ ] New service pages were added to `supported-services.mdx` in the correct table, alphabetically
-- [ ] Unmapped files were reported to the user

.claude/skills/update-docs/SOURCE_DOC_MAPPING.md

@@ -1,79 +0,0 @@
-# Source-to-Doc Mapping
-
-Maps pipecat source files to their documentation pages. Source paths are relative to `src/pipecat/`. Doc paths are relative to `DOCS_PATH`.
-
-## Name mismatches
-
-These source paths don't follow the standard `services/{provider}/{type}.py` → `server/services/{type}/{provider}.mdx` pattern.
-
-| Source path | Doc page |
-|---|---|
-| `services/google/llm.py` | `server/services/llm/gemini.mdx` |
-| `services/google/llm_vertex.py` | `server/services/llm/google-vertex.mdx` |
-| `services/google/google.py` | (shared base — check which services use it) |
-| `services/google/gemini_live/**` | `server/services/s2s/gemini-live.mdx` |
-| `services/google/gemini_live/llm_vertex.py` | `server/services/s2s/gemini-live-vertex.mdx` |
-| `services/aws_nova_sonic/**` | `server/services/s2s/aws.mdx` |
-| `services/ultravox/**` | `server/services/s2s/ultravox.mdx` |
-| `services/grok/realtime/**` | `server/services/s2s/grok.mdx` |
-| `services/openai/realtime/**` | `server/services/s2s/openai.mdx` |
-| `processors/frameworks/rtvi.py` | `server/frameworks/rtvi/rtvi-processor.mdx` and `server/frameworks/rtvi/rtvi-observer.mdx` |
-| `processors/transcript_processor.py` | `server/utilities/transcript-processor.mdx` |
-| `processors/user_idle_processor.py` | `server/utilities/user-idle-processor.mdx` |
-| `processors/idle_frame_processor.py` | `server/pipeline/pipeline-idle-detection.mdx` |
-| `pipeline/task.py` | `server/pipeline/pipeline-task.mdx` |
-| `pipeline/runner.py` | `server/utilities/runner/guide.mdx` |
-| `transports/base_transport.py` | `server/services/transport/transport-params.mdx` |
-
-## Skip list
-
-These files should never trigger doc updates.
-
-| Pattern | Reason |
-|---|---|
-| `services/ai_service.py` | Internal base class |
-| `services/stt_service.py` | Internal base class |
-| `services/tts_service.py` | Internal base class |
-| `services/llm_service.py` | Internal base class |
-| `services/websocket_service.py` | Internal base class |
-| `services/openai_realtime_beta/**` | Deprecated |
-| `services/openai_realtime/**` | Deprecated |
-| `services/gemini_multimodal_live/**` | Deprecated |
-| `services/aws/agent_core.py` | Internal |
-| `services/aws/sagemaker/**` | No doc page |
-| `transports/base_input.py` | Internal base class |
-| `transports/base_output.py` | Internal base class |
-| `transports/websocket/client.py` | No doc page |
-| `serializers/base_serializer.py` | Internal base class |
-| `serializers/protobuf.py` | Internal |
-| `processors/audio/**` | Internal |
-| `pipeline/pipeline.py` | Core architecture, not a service doc |
-
-## Pattern matching
-
-For files not in the tables above, apply these patterns. Convert underscores to hyphens in provider names for doc filenames.
-
-| Source pattern | Doc pattern |
-|---|---|
-| `services/{provider}/stt*.py` | `server/services/stt/{provider}.mdx` |
-| `services/{provider}/tts*.py` | `server/services/tts/{provider}.mdx` |
-| `services/{provider}/llm*.py` | `server/services/llm/{provider}.mdx` |
-| `services/{provider}/image*.py` | `server/services/image-generation/{provider}.mdx` |
-| `services/{provider}/video*.py` | `server/services/video/{provider}.mdx` |
-| `services/{provider}/realtime/**` | `server/services/s2s/{provider}.mdx` |
-| `transports/{name}/**` | `server/services/transport/{name}.mdx` |
-| `serializers/{name}.py` | `server/services/serializers/{name}.mdx` |
-| `observers/**` | `server/utilities/observers/` (match by class name) |
-| `audio/vad/**` | `server/utilities/audio/` (match by class name) |
-| `audio/filters/**` | `server/utilities/audio/` (match by class name) |
-| `audio/mixers/**` | `server/utilities/audio/` (match by class name) |
-| `processors/filters/**` | `server/utilities/filters/` (match by class name) |
-
-If the doc file doesn't exist at the resolved path, the file is **unmapped**.
-
-## Search fallback
-
-For files that don't match any table or pattern above:
-1. Extract the main class name(s) from the source file
-2. Search the docs directory for that class name: `grep -r "ClassName" DOCS_PATH/server/`
-3. If found in a doc page, use that as the mapping

.dockerignore

@@ -0,0 +1,30 @@
+# flyctl launch added from .gitignore
+**/.vscode
+**/env
+**/__pycache__
+**/*~
+**/venv
+#*#
+
+# Distribution / packaging
+**/.Python
+**/build
+**/develop-eggs
+**/dist
+**/downloads
+**/eggs
+**/.eggs
+**/lib
+**/lib64
+**/parts
+**/sdist
+**/var
+**/wheels
+**/share/python-wheels
+**/*.egg-info
+**/.installed.cfg
+**/*.egg
+**/MANIFEST
+**/.DS_Store
+**/.env
+fly.toml

.github/workflows/android.yaml

@@ -0,0 +1,48 @@
+name: android
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "examples/simple-chatbot/client/android/**"
+  pull_request:
+    branches:
+      - "**"
+    paths:
+      - "examples/simple-chatbot/client/android/**"
+  workflow_dispatch:
+    inputs:
+      sdk_git_ref:
+        type: string
+        description: "Which git ref of the app to build"
+
+concurrency:
+  group: build-android-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  sdk:
+    name: "Simple chatbot demo"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.sdk_git_ref || github.ref }}
+
+      - name: "Install Java"
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+
+      - name: Build demo app
+        working-directory: examples/simple-chatbot/client/android
+        run: ./gradlew :simple-chatbot-client:assembleDebug
+
+      - name: Upload demo APK
+        uses: actions/upload-artifact@v4
+        with:
+          name: Simple Chatbot Android Client
+          path: examples/simple-chatbot/client/android/simple-chatbot-client/build/outputs/apk/debug/simple-chatbot-client-debug.apk

.github/workflows/build.yaml

@@ -21,20 +21,24 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: "latest"
-
       - name: Set up Python
-        run: uv python install 3.12
-
-      - name: Install development dependencies
-        run: uv sync --group dev
-
+        id: setup_python
+        uses: actions/setup-python@v4
+        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: uv build
-
-      - name: Install project in editable mode
-        run: uv pip install --editable .
+        run: |
+          source .venv/bin/activate
+          python -m build
+      - name: Install project and other Python dependencies
+        run: |
+          source .venv/bin/activate
+          pip install --editable .

.github/workflows/coverage.yaml

@@ -18,40 +18,35 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: "latest"
-
       - name: Set up Python
-        run: uv python install 3.12
-
+        id: setup_python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Cache virtual environment
+        uses: actions/cache@v3
+        with:
+          # We are hashing dev-requirements.txt and test-requirements.txt which
+          # contain all dependencies needed to run the tests.
+          key: venv-${{ runner.os }}-${{ steps.setup_python.outputs.python-version}}-${{ hashFiles('dev-requirements.txt') }}-${{ hashFiles('test-requirements.txt') }}
+          path: .venv
       - name: Install system packages
+        id: install_system_packages
         run: |
-          sudo apt-get update
           sudo apt-get install -y portaudio19-dev
-
-      - name: Install dependencies
+      - name: Setup virtual environment
         run: |
-          uv sync --group dev \
-            --extra anthropic \
-            --extra aws \
-            --extra deepgram \
-            --extra google \
-            --extra langchain \
-            --extra livekit \
-            --extra piper \
-            --extra runner \
-            --extra sagemaker \
-            --extra tracing \
-            --extra websocket
-
+          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 -r test-requirements.txt
       - name: Run tests with coverage
         run: |
-          uv run coverage run
-          uv run coverage xml
-
+          source .venv/bin/activate
+          coverage run
+          coverage xml
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
         with:

.github/workflows/format.yaml

@@ -17,33 +17,30 @@ concurrency:
 
 jobs:
   ruff-format:
-    name: "Code quality checks"
+    name: "Formatting checker"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: "latest"
-
       - name: Set up Python
-        run: uv python install 3.12
-
-      - name: Install development dependencies
-        # `--all-extras` (matching the dev setup in README.md) so pyright can
-        # resolve types from various optional dependencies.
-        run: uv sync --group dev --all-extras --no-extra gstreamer --no-extra local
-
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Setup virtual environment
+        run: |
+          python -m venv .venv
+      - name: Install development Python dependencies
+        run: |
+          source .venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install -r dev-requirements.txt
       - name: Ruff formatter
         id: ruff-format
-        run: uv run ruff format --diff
-
-      - name: Ruff linter (all rules)
+        run: |
+          source .venv/bin/activate
+          ruff format --diff
+      - name: Ruff import linter
         id: ruff-check
-        run: uv run ruff check
-
-      - name: Type check (pyright)
-        id: pyright
-        run: uv run pyright
+        run: |
+          source .venv/bin/activate
+          ruff check --select I

.github/workflows/generate-changelog.yml

@@ -1,174 +0,0 @@
-name: Generate Changelog for Release
-
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: "Release version (e.g., 0.0.97)"
-        required: true
-        type: string
-      date:
-        description: "Release date (YYYY-MM-DD format, defaults to today)"
-        required: false
-        type: string
-        default: ""
-
-permissions:
-  contents: write
-  pull-requests: write
-
-jobs:
-  generate-changelog:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v4
-        with:
-          enable-cache: true
-
-      - name: Install dependencies
-        run: |
-          uv sync --group dev
-
-      - name: Set release date
-        id: set_date
-        run: |
-          if [ -z "${{ inputs.date }}" ]; then
-            RELEASE_DATE=$(date +%Y-%m-%d)
-            echo "Using today's date: $RELEASE_DATE"
-          else
-            RELEASE_DATE="${{ inputs.date }}"
-            echo "Using provided date: $RELEASE_DATE"
-          fi
-          echo "release_date=$RELEASE_DATE" >> $GITHUB_OUTPUT
-
-      - name: Validate inputs
-        run: |
-          # Validate version format (basic check)
-          if ! [[ "${{ inputs.version }}" =~ ^[0-9]+\.[0-9]+\.[0-9]+.*$ ]]; then
-            echo "Error: Version must be in format X.Y.Z (e.g., 0.0.97)"
-            exit 1
-          fi
-
-          # Validate date format if provided
-          if [ -n "${{ inputs.date }}" ]; then
-            if ! date -d "${{ inputs.date }}" >/dev/null 2>&1; then
-              # Try macOS date format
-              if ! date -j -f "%Y-%m-%d" "${{ inputs.date }}" >/dev/null 2>&1; then
-                echo "Error: Date must be in YYYY-MM-DD format (e.g., 2025-12-04)"
-                exit 1
-              fi
-            fi
-          fi
-
-      - name: Check for changelog fragments
-        id: check_fragments
-        run: |
-          FRAGMENT_COUNT=$(find changelog -name "*.md" ! -name "_template.md.j2" | wc -l | tr -d ' ')
-          echo "fragment_count=$FRAGMENT_COUNT" >> $GITHUB_OUTPUT
-
-          if [ "$FRAGMENT_COUNT" -eq "0" ]; then
-            echo "❌ Error: No changelog fragments found in changelog/"
-            echo ""
-            echo "Cannot create a release without changelog entries."
-            echo "Add changelog fragments to the changelog/ directory (e.g., 1234.added.md) and try again."
-            exit 1
-          fi
-
-          # Validate fragment types
-          VALID_TYPES="added changed deprecated removed fixed performance security other"
-          INVALID_FRAGMENTS=""
-
-          for file in changelog/*.md; do
-            # Skip template
-            if [[ "$file" == "changelog/_template.md.j2" ]]; then
-              continue
-            fi
-            
-            # Extract type from filename (e.g., 1234.added.md -> added)
-            filename=$(basename "$file")
-            # Handle both 1234.added.md and 1234.added.2.md patterns
-            type=$(echo "$filename" | sed -E 's/^[0-9]+\.([a-z]+)(\.[0-9]+)?\.md$/\1/')
-            
-            # Check if type is valid
-            if ! echo "$VALID_TYPES" | grep -wq "$type"; then
-              INVALID_FRAGMENTS="$INVALID_FRAGMENTS\n  - $filename (type: '$type')"
-            fi
-          done
-
-          if [ -n "$INVALID_FRAGMENTS" ]; then
-            echo "❌ Error: Invalid changelog fragment types found:"
-            echo -e "$INVALID_FRAGMENTS"
-            echo ""
-            echo "Valid types are: $VALID_TYPES"
-            echo "Example: 1234.added.md, 5678.fixed.md"
-            exit 1
-          fi
-
-          echo "✓ Found $FRAGMENT_COUNT changelog fragment(s)"
-          echo "has_fragments=true" >> $GITHUB_OUTPUT
-
-      - name: Preview changelog
-        run: |
-          echo "## Preview of changelog for version ${{ inputs.version }}"
-          echo ""
-          uv run towncrier build --draft --version "${{ inputs.version }}" --date "${{ steps.set_date.outputs.release_date }}"
-
-      - name: Build changelog
-        run: |
-          uv run towncrier build --version "${{ inputs.version }}" --date "${{ steps.set_date.outputs.release_date }}" --yes
-
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v7
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: "Update changelog for version ${{ inputs.version }}"
-          title: "Release ${{ inputs.version }} - Changelog Update"
-          body: |
-            ## Changelog Update for Release ${{ inputs.version }}
-
-            This PR updates the CHANGELOG.md with all changes for version **${{ inputs.version }}**.
-
-            ### Summary
-            - **Version:** ${{ inputs.version }}
-            - **Date:** ${{ steps.set_date.outputs.release_date }}
-            - **Fragments processed:** ${{ steps.check_fragments.outputs.fragment_count }}
-
-            ### What this PR does
-            - ✅ Adds new release section to CHANGELOG.md
-            - ✅ Removes processed changelog fragments
-            - ✅ Ready to merge for release
-
-            ### Next Steps
-            1. Review the changelog entries below
-            2. Make any necessary edits to CHANGELOG.md if needed
-            3. Merge this PR
-            4. Continue with your release process
-
-            ---
-
-            <details>
-            <summary>📋 Preview of changes</summary>
-
-            The changelog has been updated with entries from the following fragments:
-
-            ```bash
-            ${{ steps.check_fragments.outputs.fragment_count }} fragments processed
-            ```
-
-            </details>
-          branch: changelog-${{ inputs.version }}
-          delete-branch: true
-          labels: |
-            changelog
-            release

.github/workflows/publish.yaml

@@ -5,29 +5,35 @@ on:
     inputs:
       gitref:
         type: string
-        description: 'what git tag to build (e.g. v0.0.74)'
+        description: "what git ref to build"
         required: true
 
 jobs:
   build:
-    name: 'Build and upload wheels'
+    name: "Build and upload wheels"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.inputs.gitref }}
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: 'latest'
       - name: Set up Python
-        run: uv python install 3.12
-      - name: Install development dependencies
-        run: uv sync --group dev
+        id: setup_python
+        uses: actions/setup-python@v4
+        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: uv build
+        run: |
+          source .venv/bin/activate
+          python -m build
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -35,9 +41,9 @@ jobs:
           path: ./dist
 
   publish-to-pypi:
-    name: 'Publish to PyPI'
+    name: "Publish to PyPI"
     runs-on: ubuntu-latest
-    needs: [build]
+    needs: [ build ]
     environment:
       name: pypi
       url: https://pypi.org/p/pipecat-ai
@@ -56,12 +62,12 @@ jobs:
           print-hash: true
 
   publish-to-test-pypi:
-    name: 'Publish to Test PyPI'
+    name: "Publish to Test PyPI"
     runs-on: ubuntu-latest
-    needs: [build]
+    needs: [ build ]
     environment:
       name: testpypi
-      url: https://test.pypi.org/p/pipecat-ai
+      url: https://pypi.org/p/pipecat-ai
     permissions:
       id-token: write
     steps:
@@ -70,7 +76,7 @@ jobs:
         with:
           name: wheels
           path: ./dist
-      - name: Publish to Test PyPI
+      - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           verbose: true

.github/workflows/publish_test.yaml

@@ -4,7 +4,7 @@ on: workflow_dispatch
 
 jobs:
   build:
-    name: 'Build and upload wheels'
+    name: "Build and upload wheels"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
@@ -12,16 +12,23 @@ jobs:
         with:
           fetch-tags: true
           fetch-depth: 100
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: 'latest'
       - name: Set up Python
-        run: uv python install 3.12
-      - name: Install development dependencies
-        run: uv sync --group dev
+        id: setup_python
+        uses: actions/setup-python@v4
+        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: uv build
+        run: |
+          source .venv/bin/activate
+          python -m build
       - name: Upload wheels
         uses: actions/upload-artifact@v4
         with:
@@ -29,12 +36,12 @@ jobs:
           path: ./dist
 
   publish-to-test-pypi:
-    name: 'Publish to Test PyPI'
+    name: "Publish to Test PyPI"
     runs-on: ubuntu-latest
-    needs: [build]
+    needs: [ build ]
     environment:
       name: testpypi
-      url: https://test.pypi.org/p/pipecat-ai
+      url: https://pypi.org/p/pipecat-ai
     permissions:
       id-token: write
     steps:
@@ -43,7 +50,7 @@ jobs:
         with:
           name: wheels
           path: ./dist
-      - name: Publish to Test PyPI
+      - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           verbose: true

.github/workflows/python-compatibility.yaml

@@ -1,50 +0,0 @@
-name: Python Compatibility Test
-
-on:
-  push:
-    branches: [main, develop]
-    paths: ['pyproject.toml']
-  pull_request:
-    branches: [main, develop]
-    paths: ['pyproject.toml']
-
-jobs:
-  test-compatibility:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ['3.11.15', '3.12.13', '3.13.12', '3.14.3']
-
-    name: Python ${{ matrix.python-version }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Install system dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y \
-            portaudio19-dev \
-            libcairo2-dev \
-            libgirepository1.0-dev \
-            pkg-config
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v4
-        with:
-          version: 'latest'
-
-      - name: Set up Python ${{ matrix.python-version }}
-        run: |
-          uv python install ${{ matrix.python-version }}
-          uv python pin ${{ matrix.python-version }}
-
-      - name: Test uv sync with all extras
-        run: |
-          uv sync --group dev --all-extras
-
-      - name: Verify installation
-        run: |
-          uv run python --version
-          uv run python -c "import pipecat; print('✅ Pipecat imports successfully')"

.github/workflows/tests.yaml

@@ -22,35 +22,31 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          version: "latest"
-
       - name: Set up Python
-        run: uv python install 3.12
-
+        id: setup_python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Cache virtual environment
+        uses: actions/cache@v3
+        with:
+          # We are hashing dev-requirements.txt and test-requirements.txt which
+          # contain all dependencies needed to run the tests.
+          key: venv-${{ runner.os }}-${{ steps.setup_python.outputs.python-version}}-${{ hashFiles('dev-requirements.txt') }}-${{ hashFiles('test-requirements.txt') }}
+          path: .venv
       - name: Install system packages
+        id: install_system_packages
         run: |
-          sudo apt-get update
           sudo apt-get install -y portaudio19-dev
-
-      - name: Install dependencies
+      - name: Setup virtual environment
         run: |
-          uv sync --group dev \
-            --extra anthropic \
-            --extra aws \
-            --extra deepgram \
-            --extra google \
-            --extra langchain \
-            --extra livekit \
-            --extra piper \
-            --extra runner \
-            --extra sagemaker \
-            --extra tracing \
-            --extra websocket
-
+          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 -r test-requirements.txt
       - name: Test with pytest
         run: |
-          uv run pytest
+          source .venv/bin/activate
+          pytest

.github/workflows/update-docs.yml

@@ -1,148 +0,0 @@
-name: Update Documentation on PR Merge
-
-on:
-  pull_request_target:
-    types: [closed]
-    branches: [main]
-    paths:
-      - "src/pipecat/services/**"
-      - "src/pipecat/transports/**"
-      - "src/pipecat/serializers/**"
-      - "src/pipecat/processors/**"
-      - "src/pipecat/audio/**"
-      - "src/pipecat/turns/**"
-      - "src/pipecat/observers/**"
-      - "src/pipecat/pipeline/**"
-  workflow_dispatch:
-    inputs:
-      pr_number:
-        description: "PR number to generate docs for"
-        required: true
-        type: string
-
-jobs:
-  update-docs:
-    if: >-
-      github.event_name == 'workflow_dispatch' ||
-      github.event.pull_request.merged == true
-    runs-on: ubuntu-latest
-    timeout-minutes: 15
-    permissions:
-      contents: read
-      pull-requests: read
-      id-token: write
-    steps:
-      - name: Checkout pipecat
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Checkout docs
-        uses: actions/checkout@v4
-        with:
-          repository: pipecat-ai/docs
-          token: ${{ secrets.DOCS_SYNC_TOKEN }}
-          path: _docs
-
-      - name: Resolve PR number
-        id: pr
-        run: |
-          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
-            echo "number=${{ inputs.pr_number }}" >> "$GITHUB_OUTPUT"
-          else
-            echo "number=${{ github.event.pull_request.number }}" >> "$GITHUB_OUTPUT"
-          fi
-
-      - name: Update documentation
-        uses: anthropics/claude-code-action@v1
-        env:
-          DOCS_SYNC_TOKEN: ${{ secrets.DOCS_SYNC_TOKEN }}
-        with:
-          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          prompt: |
-            You are updating documentation for the pipecat-ai/docs repository based on
-            changes merged in PR #${{ steps.pr.outputs.number }} of pipecat-ai/pipecat.
-
-            ## Setup
-
-            1. Read the skill instructions at `.claude/skills/update-docs/SKILL.md`
-            2. Read the source-to-doc mapping at `.claude/skills/update-docs/SOURCE_DOC_MAPPING.md`
-            3. The docs repository is checked out at `./_docs/`
-
-            ## Get the diff
-
-            Run `gh pr diff ${{ steps.pr.outputs.number }}` to see what changed in the PR.
-            Also run `gh pr diff ${{ steps.pr.outputs.number }} --name-only` to get the list of changed files.
-            Filter to source files matching the directories listed in SKILL.md Step 3.
-
-            If no relevant source files were changed, exit with "No documentation changes needed."
-
-            ## Follow the skill instructions
-
-            Apply the SKILL.md workflow (Steps 3-9) with these adaptations for automation:
-
-            ### Docs path
-            Use `./_docs/` — it's already checked out. Do not ask for a path.
-
-            ### Branch management
-            - Branch name: `docs/pr-${{ steps.pr.outputs.number }}`
-            - Work inside `./_docs/` for all doc edits and git operations
-            - Check if the branch already exists on the remote:
-              ```bash
-              cd _docs && git fetch origin docs/pr-${{ steps.pr.outputs.number }} 2>/dev/null
-              ```
-              - If it exists: check it out (supports workflow re-runs)
-              - If not: create it from main
-
-            ### Git config
-            Before committing in `_docs`, set:
-            ```bash
-            git config user.name "github-actions[bot]"
-            git config user.email "github-actions[bot]@users.noreply.github.com"
-            ```
-
-            ### No interactive questions
-            Do not ask questions. If you encounter gaps (unmapped files, missing sections,
-            ambiguous changes), note them in the PR body under "## Gaps identified".
-
-            ### Creating the docs PR
-            After committing all changes in `_docs`, push and create a PR:
-            ```bash
-            cd _docs
-            git push -u origin docs/pr-${{ steps.pr.outputs.number }}
-            GH_TOKEN=$DOCS_SYNC_TOKEN gh pr create \
-              --repo pipecat-ai/docs \
-              --label auto-docs \
-              --label pipecat \
-              --title "docs: update for pipecat PR #${{ steps.pr.outputs.number }}" \
-              --body "$(cat <<'BODY'
-            Automated documentation update for [pipecat PR #${{ steps.pr.outputs.number }}](https://github.com/pipecat-ai/pipecat/pull/${{ steps.pr.outputs.number }}).
-
-            ## Changes
-            <summarize each doc page updated and what changed>
-
-            ## Gaps identified
-            <any unmapped files, missing doc pages, or missing sections — or "None">
-            BODY
-            )"
-            ```
-
-            ### Re-run handling
-            If `gh pr create` fails because a PR from that branch already exists,
-            push the updated commits and use `gh pr edit` to update the body instead.
-
-            ### No-op
-            If after analyzing the diff you determine no documentation changes are needed
-            (e.g., only skip-listed files changed, or changes don't affect public API docs),
-            exit cleanly without creating a branch or PR. Output "No documentation changes needed."
-
-            ## Important rules
-            - Only modify files inside `./_docs/` — never modify pipecat source code
-            - Follow the conservative editing rules from SKILL.md Step 6
-            - Read each doc page fully before editing (SKILL.md Guidelines)
-            - Use `GH_TOKEN=$DOCS_SYNC_TOKEN` for all `gh` commands targeting pipecat-ai/docs
-          claude_args: |
-            --model claude-sonnet-4-5-20250929
-            --max-turns 30
-            --allowedTools "Read,Write,Edit,Glob,Grep,Bash"

.gitignore

@@ -4,14 +4,7 @@ __pycache__/
 *~
 venv
 .venv
-.idea
-.gradle
-.next
-next-env.d.ts
-local.properties
-*.log
-*.lock
-smart_turn_audio_log
+/.idea
 #*#
 
 # Distribution / Packaging
@@ -34,10 +27,12 @@ share/python-wheels/
 *.egg
 MANIFEST
 .DS_Store
-.env*
+.env
 fly.toml
 
 # Examples
+examples/telnyx-chatbot/templates/streams.xml
+examples/twilio-chatbot/templates/streams.xml
 examples/**/node_modules/
 examples/**/.expo/
 examples/**/dist/
@@ -55,10 +50,4 @@ examples/**/web-build/
 
 # Documentation
 docs/api/_build/
-docs/api/api
-
-# uv
-.python-version
-
-# Pipecat
-whisker_setup.py
+docs/api/api

.pre-commit-config.yaml

@@ -1,13 +1,8 @@
 repos:
-  - repo: local
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.7
     hooks:
       - id: ruff
-        name: ruff
-        entry: uv run ruff check --fix
-        language: system
-        types: [python]
+        language_version: python3
+        args: [ --select,  I, ]
       - id: ruff-format
-        name: ruff-format
-        entry: uv run ruff format
-        language: system
-        types: [python]

.readthedocs.yaml

@@ -9,14 +9,22 @@ build:
     - python3-dev
     - libasound2-dev
   jobs:
-    post_install:
-      - pip install uv
-      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --all-extras --no-extra gstreamer --no-extra local_smart_turn --no-extra moondream --no-extra mlx-whisper
+    pre_build:
+      - python -m pip install --upgrade pip
+      - pip install wheel setuptools
+    post_build:
+      - echo "Build completed"
 
 sphinx:
   configuration: docs/api/conf.py
   fail_on_warning: false
 
+python:
+  install:
+    - requirements: docs/api/requirements.txt
+    - method: pip
+      path: .
+
 search:
   ranking:
     api/*: 5

AGENTS.md

@@ -1,174 +0,0 @@
-# AGENTS.md
-
-This file provides guidance to AI coding agents when working with code in this repository.
-
-## Project Overview
-
-Pipecat is an open-source Python framework for building real-time voice and multimodal conversational AI agents. It orchestrates audio/video, AI services, transports, and conversation pipelines using a frame-based architecture.
-
-## Common Commands
-
-```bash
-# Setup development environment
-uv sync --group dev --all-extras --no-extra gstreamer --no-extra local
-
-# Install pre-commit hooks
-uv run pre-commit install
-
-# Run all tests
-uv run pytest
-
-# Run a single test file
-uv run pytest tests/test_name.py
-
-# Run a specific test
-uv run pytest tests/test_name.py::test_function_name
-
-# Preview changelog
-uv run towncrier build --draft --version Unreleased
-
-# Lint and format check
-uv run ruff check
-uv run ruff format --check
-
-# Update dependencies (after editing pyproject.toml)
-uv lock && uv sync
-```
-
-## Architecture
-
-### Frame-Based Pipeline Processing
-
-All data flows as **Frame** objects through a pipeline of **FrameProcessors**:
-
-```
-[Processor1] → [Processor2] → ... → [ProcessorN]
-```
-
-**Key components:**
-
-- **Frames** (`src/pipecat/frames/frames.py`): Data units (audio, text, video) and control signals. Flow DOWNSTREAM (input→output) or UPSTREAM (acknowledgments/errors).
-
-- **FrameProcessor** (`src/pipecat/processors/frame_processor.py`): Base processing unit. Each processor receives frames, processes them, and pushes results downstream.
-
-- **Pipeline** (`src/pipecat/pipeline/pipeline.py`): Chains processors together.
-
-- **ParallelPipeline** (`src/pipecat/pipeline/parallel_pipeline.py`): Runs multiple pipelines in parallel.
-
-- **Transports** (`src/pipecat/transports/`): Transports are frame processors used for external I/O layer (Daily WebRTC, LiveKit WebRTC, WebSocket, Local). Abstract interface via `BaseTransport`, `BaseInputTransport` and `BaseOutputTransport`.
-
-- **Pipeline Task (`src/pipecat/pipeline/task.py`)**: Runs and manages a pipeline. Pipeline tasks send the first frame, `StartFrame`, to the pipeline in order for processors to know they can start processing and pushing frames. Pipeline tasks internally create a pipeline with two additional processors, a source processor before the user-defined pipeline and a sink processor at the end. Those are used for multiple things: error handling, pipeline task level events, heartbeat monitoring, etc.
-
-- **Pipeline Runner (`src/pipecat/pipeline/runner.py`)**: High-level entry point for executing pipeline tasks. Handles signal management (SIGINT/SIGTERM) for graceful shutdown and optional garbage collection. Run a single pipeline task with `await runner.run(task)` or multiple concurrently with `await asyncio.gather(runner.run(task1), runner.run(task2))`.
-
-- **Services** (`src/pipecat/services/`): 60+ AI provider integrations (STT, TTS, LLM, etc.). Extend base classes: `AIService`, `LLMService`, `STTService`, `TTSService`, `VisionService`.
-
-- **Serializers** (`src/pipecat/serializers/`): Convert frames to/from wire formats for WebSocket transports. `FrameSerializer` base class defines `serialize()` and `deserialize()`. Telephony serializers (Twilio, Plivo, Vonage, Telnyx, Exotel, Genesys) handle provider-specific protocols and audio encoding (e.g., μ-law).
-
-- **RTVI** (`src/pipecat/processors/frameworks/rtvi.py`): Real-Time Voice Interface protocol bridging clients and the pipeline. `RTVIProcessor` handles incoming client messages (text input, audio, function call results). `RTVIObserver` converts pipeline frames to outgoing messages: user/bot speaking events, transcriptions, LLM/TTS lifecycle, function calls, metrics, and audio levels.
-
-- **Observers** (`src/pipecat/observers/`): Monitor frame flow without modifying the pipeline. Passed to `PipelineTask` via the `observers` parameter. Implement `on_process_frame()` and `on_push_frame()` callbacks.
-
-### Important Patterns
-
-- **Context Aggregation**: `LLMContext` accumulates messages for LLM calls; `UserResponse` aggregates user input
-
-- **Turn Management**: Turn management is done through `LLMUserAggregator` and
-  `LLMAssistantAggregator`, created with `LLMContextAggregatorPair`
-
-- **User turn strategies**: Detection of when the user starts and stops speaking is done via user turn start/stop strategies. They push `UserStartedSpeakingFrame` and `UserStoppedSpeakingFrame` respectively.
-
-- **Interruptions**: Interruptions are usually triggered by a user turn start strategy (e.g. `VADUserTurnStartStrategy`) but they can be triggered by other processors as well, in which case the user turn start strategies don't need to. An `InterruptionFrame` carries an optional `asyncio.Event` that is set when the frame reaches the pipeline sink. If a processor stops an `InterruptionFrame` from propagating downstream (i.e., doesn't push it), it **must** call `frame.complete()` to avoid stalling `push_interruption_task_frame_and_wait()` callers.
-
-- **Uninterruptible Frames**: These are frames that will not be removed from internal queues even if there's an interruption. For example, `EndFrame` and `StopFrame`.
-
-- **Events**: Most classes in Pipecat have `BaseObject` as the very base class. `BaseObject` has support for events. Events can run in the background in an async task (default) or synchronously (`sync=True`) if we want immediate action. Synchronous event handlers need to execute fast.
-
-- **Async Task Management**: Always use `self.create_task(coroutine, name)` instead of raw `asyncio.create_task()`. The `TaskManager` automatically tracks tasks and cleans them up on processor shutdown. Use `await self.cancel_task(task, timeout)` for cancellation.
-
-- **Error Handling**: Use `await self.push_error(msg, exception, fatal)` to push errors upstream. Services should use `fatal=False` (the default) so application code can handle errors and take action (e.g. switch to another service).
-
-### Key Directories
-
-| Directory                  | Purpose                                            |
-| -------------------------- | -------------------------------------------------- |
-| `src/pipecat/frames/`      | Frame definitions (100+ types)                     |
-| `src/pipecat/processors/`  | FrameProcessor base + aggregators, filters, audio  |
-| `src/pipecat/pipeline/`    | Pipeline orchestration                             |
-| `src/pipecat/services/`    | AI service integrations (60+ providers)            |
-| `src/pipecat/transports/`  | Transport layer (Daily, LiveKit, WebSocket, Local) |
-| `src/pipecat/serializers/` | Frame serialization for WebSocket protocols        |
-| `src/pipecat/observers/`   | Pipeline observers for monitoring frame flow       |
-| `src/pipecat/audio/`       | VAD, filters, mixers, turn detection, DTMF         |
-| `src/pipecat/turns/`       | User turn management                               |
-
-## Code Style
-
-- **Docstrings**: Google-style. Classes describe purpose; `__init__` has `Args:` section; dataclasses use `Parameters:` section.
-- **Deprecations**: Use the `.. deprecated:: <version>` Sphinx directive in docstrings (never inline tags like `[DEPRECATED]`), and pair it with a runtime `warnings.warn(..., DeprecationWarning)` at the call site. See `CONTRIBUTING.md` for full conventions.
-- **Linting**: Ruff (line length 100). Pre-commit hooks enforce formatting.
-- **Type hints**: Required for complex async code.
-- **Dataclass vs Pydantic**: Use `@dataclass` for frames and internal pipeline data (high-frequency, no validation needed). Use Pydantic `BaseModel` for configuration, parameters, metrics, and external API data (benefits from validation and serialization). Specifically:
-  - `@dataclass`: Frame types, context aggregator pairs, internal data containers
-  - `BaseModel`: Service `InputParams`, transport/VAD/turn params, metrics data, API request/response models, serializer params
-
-### Docstring Example
-
-```python
-class MyService(LLMService):
-    """Description of what the service does.
-
-    More detailed description.
-
-    Event handlers available:
-
-    - on_connected: Called when we are connected
-
-    Example::
-
-        @service.event_handler("on_connected")
-        async def on_connected(service, frame):
-            ...
-    """
-
-    def __init__(self, param1: str, **kwargs):
-        """Initialize the service.
-
-        Args:
-            param1: Description of param1.
-            **kwargs: Additional arguments passed to parent.
-        """
-        super().__init__(**kwargs)
-
-
-# Pydantic params class with a deprecated field
-class MyParams(BaseModel):
-    """Configuration parameters for MyService.
-
-    Parameters:
-        new_setting: Replacement for ``old_setting``.
-        old_setting: Legacy setting, no longer used.
-
-            .. deprecated:: 1.2.0
-                Use ``new_setting`` instead. Will be removed in 2.0.0.
-    """
-
-    new_setting: str = "default"
-    old_setting: str | None = None
-```
-
-## Service Implementation
-
-When adding a new service:
-
-1. Extend the appropriate base class (`STTService`, `TTSService`, `LLMService`, etc.)
-2. Implement required abstract methods
-3. Handle necessary frames
-4. By default, all frames should be pushed in the direction they came
-5. Push `ErrorFrame` on failures
-6. Add metrics tracking via `MetricsData` if relevant
-7. Follow the pattern of existing services in `src/pipecat/services/`
-
-## Testing
-
-Test utilities live in `src/pipecat/tests/utils.py`. Use `run_test()` to send frames through a pipeline and assert expected output frames in each direction. Use `SleepFrame(sleep=N)` to add delays between frames.

CHANGELOG.md.template

@@ -0,0 +1,62 @@
+# Changelog
+
+All notable changes to the **<project name>** SDK 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).
+
+Please make sure to add your changes to the appropriate categories:
+
+## [Unreleased]
+
+### Added
+
+<!-- for new functionality -->
+
+- n/a
+
+### Changed
+
+<!-- for changed functionality -->
+
+- n/a
+
+### Deprecated
+
+<!-- for soon-to-be removed functionality -->
+
+- n/a
+
+### Removed
+
+<!-- for removed functionality -->
+
+- n/a
+
+### Fixed
+
+<!-- for fixed bugs -->
+
+- n/a
+
+### Performance
+
+<!-- for performance-relevant changes -->
+
+- n/a
+
+### Security
+
+<!-- for security-relevant changes -->
+
+- n/a
+
+### Other
+
+<!-- for everything else -->
+
+- n/a
+
+## [0.1.0] - YYYY-MM-DD
+
+Initial release.

CLAUDE.md

@@ -1 +0,0 @@
-@AGENTS.md

COMMUNITY_INTEGRATIONS.md

@@ -1,474 +0,0 @@
-# Community Integrations Guide
-
-Pipecat welcomes community-maintained integrations! As our ecosystem grows, we've established a process for any developer to create and maintain their own service integrations while ensuring discoverability for the Pipecat community.
-
-## Overview
-
-**What we support:** Community-maintained integrations that live in separate repositories and are maintained by their authors.
-
-**What we don't do:** The Pipecat team does not code review, test, or maintain community integrations. We provide guidance and list approved integrations for discoverability.
-
-**Why this approach:** This allows the community to move quickly while keeping the Pipecat core team focused on maintaining the framework itself.
-
-## Submitting your Integration
-
-To be listed as an official community integration, follow these steps:
-
-### Step 1: Build Your Integration
-
-Create your integration following the patterns and examples shown in the "Integration Patterns and Examples" section below.
-
-### Step 2: Set Up Your Repository
-
-Your repository must contain these components:
-
-- **Source code** - Complete implementation following Pipecat patterns
-- **Foundational example** - Single file example showing basic usage (see [Pipecat examples](https://github.com/pipecat-ai/pipecat/tree/main/examples))
-- **README.md** - Must include:
-  - Introduction and explanation of your integration
-  - Installation instructions
-  - Usage instructions with Pipecat Pipeline
-  - How to run your example
-  - Pipecat version compatibility (e.g., "Tested with Pipecat v0.0.86")
-  - Company attribution: If you work for the company providing the service, please mention this in your README. This helps build confidence that the integration will be actively maintained.
-
-- **LICENSE** - Permissive license (BSD-2 like Pipecat, or equivalent open source terms)
-- **Code documentation** - Source code with docstrings (we recommend following [Pipecat's docstring conventions](https://github.com/pipecat-ai/pipecat/blob/main/CONTRIBUTING.md#docstring-conventions))
-- **Changelog** - Maintain a changelog for version updates
-
-### Step 3: Join Discord
-
-Join our Discord: https://discord.gg/pipecat
-
-### Step 4: Submit for Listing
-
-Submit a pull request to add your integration to our [Community Integrations documentation page](https://docs.pipecat.ai/server/services/community-integrations).
-
-**To submit:**
-
-1. Fork the [Pipecat docs repository](https://github.com/pipecat-ai/docs)
-2. Edit the file `server/services/community-integrations.mdx`
-3. Add your integration to the appropriate service category table with:
-   - Service name
-   - Link to your repository
-   - Maintainer GitHub username(s)
-4. Include a link to your demo video (approx 30-60 seconds) in your PR description showing:
-   - Core functionality of your integration
-   - Handling of an interruption (if applicable to service type)
-5. Submit your pull request
-
-Once your PR is submitted, post in the `#community-integrations` Discord channel to let us know.
-
-## Integration Patterns and Examples
-
-### STT (Speech-to-Text) Services
-
-#### Websocket-based Services
-
-**Base class:** `WebsocketSTTService`
-
-**Use for:** Services where you manage the websocket connection directly. Combines `STTService` with `WebsocketService` for automatic reconnection and keepalive support.
-
-**Examples:**
-
-- [CartesiaSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/cartesia/stt.py)
-- [ElevenLabsRealtimeSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/elevenlabs/stt.py)
-
-#### SDK-based Streaming Services
-
-**Base class:** `STTService`
-
-**Use for:** Streaming services where the provider's Python SDK manages the connection internally.
-
-**Examples:**
-
-- [DeepgramSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/deepgram/stt.py)
-- [GoogleSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/google/stt.py)
-
-#### File-based Services
-
-**Base class:** `SegmentedSTTService`
-
-**Examples:**
-
-- [NvidiaSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/nvidia/stt.py)
-- [FalSTTService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/fal/stt.py)
-
-#### Key requirements:
-
-- STT services should push `InterimTranscriptionFrames` and `TranscriptionFrames`
-- If confidence values are available, filter for values >50% confidence
-
-### LLM (Large Language Model) Services
-
-#### OpenAI-Compatible Services
-
-**Base class:** `OpenAILLMService`
-
-**Examples:**
-
-- [AzureLLMService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/azure/llm.py)
-- [GrokLLMService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/grok/llm.py) - Shows overriding the base class where needed
-
-#### Non-OpenAI Compatible Services
-
-**Requires:** Full implementation
-
-**Examples:**
-
-- [AnthropicLLMService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/anthropic/llm.py)
-- [GoogleLLMService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/google/llm.py)
-
-#### Key requirements:
-
-- **`_process_context(self, context: LLMContext)`** — The main method that processes an LLM context and generates a response. Each LLM service overrides `process_frame` to extract context from `LLMContextFrame` and calls `_process_context`.
-
-- **`adapter_class`** — Class attribute pointing to a `BaseLLMAdapter` subclass. Defaults to `OpenAILLMAdapter`. Non-OpenAI services must implement their own adapter (see `src/pipecat/adapters/base_llm_adapter.py`) with methods:
-  - `get_llm_invocation_params(context)` — Extract provider-specific params from universal context
-  - `to_provider_tools_format(tools_schema)` — Convert standard tools to provider format
-  - `get_messages_for_logging(context)` — Format messages for logging
-  - Reference adapters: `src/pipecat/adapters/services/` (anthropic, gemini, bedrock, etc.)
-
-- **Frame sequence:** Output must follow this frame sequence pattern:
-  - `LLMFullResponseStartFrame` — Signals the start of an LLM response
-  - `LLMTextFrame` — Contains LLM content, typically streamed as tokens
-  - `LLMFullResponseEndFrame` — Signals the end of an LLM response
-
-- **Thought frames (reasoning models):** If the model supports extended thinking / chain-of-thought, emit thought frames alongside the response:
-  - `LLMThoughtStartFrame` — Signals the start of a thought
-  - `LLMThoughtTextFrame` — Contains thought content, streamed as tokens
-  - `LLMThoughtEndFrame` — Signals the end of a thought
-
-- **Context aggregation** is handled by the framework via `LLMContext` + `LLMContextAggregatorPair`. The LLM service just processes context it receives — no need to implement aggregators.
-
-### TTS (Text-to-Speech) Services
-
-#### WebsocketTTSService
-
-**Use for:** Websocket-based streaming services (with or without word timestamps)
-
-**Examples:**
-
-- [CartesiaTTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/cartesia/tts.py)
-- [ElevenLabsTTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/elevenlabs/tts.py)
-
-#### InterruptibleTTSService
-
-**Use for:** Websocket-based services without word timestamps that reconnect on interruption (e.g. don't support a context ID or interruption message)
-
-**Example:**
-
-- [SarvamTTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/sarvam/tts.py)
-
-#### TTSService
-
-**Use for:** HTTP-based services (word timestamps are supported in the base class)
-
-**Examples:**
-
-- [GoogleHttpTTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/google/tts.py)
-- [OpenAITTSService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/openai/tts.py)
-
-#### Key requirements:
-
-- For websocket services, use asyncio WebSocket implementation
-- Handle idle service timeouts with keepalives
-- TTS services push both audio (`TTSAudioRawFrame`) and text (`TTSTextFrame`) frames
-
-### Telephony Serializers
-
-Pipecat supports telephony provider integration using websocket connections to exchange MediaStreams. These services use a FrameSerializer to serialize and deserialize inputs from the FastAPIWebsocketTransport.
-
-**Examples:**
-
-- [Twilio](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/serializers/twilio.py)
-- [Telnyx](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/serializers/telnyx.py)
-
-#### Key requirements:
-
-- Include hang-up functionality using the provider's native API, ideally using `aiohttp`
-- Support DTMF (dual-tone multi-frequency) events if the provider supports them:
-  - Deserialize DTMF events from the provider's protocol to `InputDTMFFrame`
-  - Use `KeypadEntry` enum for valid keypad entries (0-9, \*, #, A-D)
-  - Handle invalid DTMF digits gracefully by returning `None`
-
-### Image Generation Services
-
-**Base class:** `ImageGenService`
-
-**Examples:**
-
-- [FalImageGenService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/fal/image.py)
-- [GoogleImageGenService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/google/image.py)
-
-#### Key requirements:
-
-- Must implement `run_image_gen` method returning an `AsyncGenerator`
-
-### Vision Services
-
-Vision services process images and provide analysis such as descriptions, object detection, or visual question answering.
-
-**Base class:** `VisionService`
-
-**Example:**
-
-- [MoondreamVisionService](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/services/moondream/vision.py)
-
-#### Key requirements:
-
-- Must implement `run_vision` method that takes a `UserImageRawFrame` and returns an `AsyncGenerator[Frame, None]`
-- The method processes the image frame and yields frames with analysis results
-- Must yield the frame sequence: `VisionFullResponseStartFrame`, `VisionTextFrame`, `VisionFullResponseEndFrame`
-
-## Implementation Guidelines
-
-### Naming Conventions
-
-#### Package and Repository Naming
-
-Use the `pipecat-{vendor}` naming convention for your PyPI package and repository:
-
-- `pipecat-{vendor}` — for single-service integrations (e.g., `pipecat-deepdub`)
-- `pipecat-{vendor}-{type}` — when a vendor offers multiple service types (e.g., `pipecat-upliftai-stt`, `pipecat-upliftai-tts`)
-
-This convention makes community packages easily discoverable via PyPI search and clearly identifies them as part of the Pipecat ecosystem.
-
-#### Class Naming
-
-- **STT:** `VendorSTTService`
-- **LLM:** `VendorLLMService`
-- **TTS:**
-  - Websocket: `VendorTTSService`
-  - HTTP: `VendorHttpTTSService`
-- **Image:** `VendorImageGenService`
-- **Vision:** `VendorVisionService`
-- **Telephony:** `VendorFrameSerializer`
-
-### Metrics Support
-
-Enable metrics in your service:
-
-```python
-def can_generate_metrics(self) -> bool:
-    """Check if this service can generate processing metrics.
-
-    Returns:
-        True, as this service supports metrics.
-    """
-    return True
-```
-
-### Service Settings
-
-Every AI service (STT, LLM, TTS, image generation, etc.) exposes a **Settings dataclass** that serves two roles:
-
-1. **Store mode** — the service's `self._settings` holds the current value of every runtime-updatable field.
-2. **Delta mode** — an update frame (e.g. `TTSUpdateSettingsFrame`) specifies only the fields that should change; unspecified fields remain `NOT_GIVEN`.
-
-#### Defining your Settings class
-
-Extend `STTSettings`, `TTSSettings`, `LLMSettings`, or `ImageGenSettings` (or, if your service directly subclasses `AIService`, `ServiceSettings`). The base classes already provide common fields (e.g. `model`, `voice`, `language`). You only need to add **service-specific knobs that should be runtime-updatable**:
-
-```python
-from dataclasses import dataclass, field
-
-from pipecat.services.settings import TTSSettings, NOT_GIVEN
-
-@dataclass
-class MyTTSSettings(TTSSettings):
-    """Settings for MyTTS service.
-
-    Parameters:
-        speaking_rate: Speed multiplier (0.5–2.0).
-    """
-
-    speaking_rate: float | None = field(default_factory=lambda: NOT_GIVEN)
-```
-
-**What goes in Settings vs. `__init__` params:**
-
-| Belongs in Settings                                      | Stays as `__init__` params                |
-| -------------------------------------------------------- | ----------------------------------------- |
-| Model name, voice, language                              | API keys, auth tokens                     |
-| Service-specific tuning knobs (rate, pitch, temperature) | Base URLs, endpoint overrides             |
-| Anything users may want to change mid-session            | Audio encoding, sample format             |
-|                                                          | Connection parameters (timeouts, retries) |
-
-The rule of thumb: if a caller might send an update frame to change it at runtime, it belongs in Settings. Everything else is init-only config stored as `self._xxx`.
-
-#### Wiring settings into `__init__`
-
-Accept an **optional** `settings` parameter. Build a `default_settings` object with all fields set to real values, then merge any caller overrides with `apply_update`.
-
-Add a `Settings` **class attribute** that points to your settings dataclass. This lets callers access the settings class through the service itself (e.g. `MyTTSService.Settings(...)`) without a separate import:
-
-```python
-from typing import Optional
-
-class MyTTSService(TTSService):
-    Settings = MyTTSSettings
-    _settings: Settings
-
-    def __init__(
-        self,
-        *,
-        api_key: str,
-        settings: Optional[Settings] = None,
-        **kwargs,
-    ):
-        # 1. Defaults — every field has a real value (store mode).
-        default_settings = self.Settings(
-            model="my-model-v1",
-            voice="default-voice",
-            language="en",
-            speaking_rate=1.0,
-        )
-
-        # 2. Merge caller overrides (only given fields win).
-        if settings is not None:
-            default_settings.apply_update(settings)
-
-        # 3. Pass the fully-populated settings to the base class.
-        super().__init__(settings=default_settings, **kwargs)
-
-        # 4. Init-only config stored separately.
-        self._api_key = api_key
-```
-
-This pattern lets callers override only what they care about:
-
-```python
-# Uses all defaults
-svc = MyTTSService(api_key="sk-xxx")
-
-# Overrides just the voice — access Settings through the service class
-svc = MyTTSService(
-    api_key="sk-xxx",
-    settings=MyTTSService.Settings(voice="custom-voice"),
-)
-```
-
-#### Reacting to runtime changes
-
-AI services support runtime configuration changes via `*UpdateSettingsFrame`s (e.g. `STTUpdateSettingsFrame`, `TTSUpdateSettingsFrame`, `LLMUpdateSettingsFrame`).
-
-To react to runtime setting changes, override `_update_settings`. The base implementation applies the delta to `self._settings` and returns a `dict` mapping each changed field name to its **pre-update** value. Your override should call `super()` first, then act on the changed fields. A common implementation might look like:
-
-```python
-async def _update_settings(self, update: TTSSettings) -> dict[str, Any]:
-    """Apply a settings update, reconfiguring the connection if needed."""
-    changed = await super()._update_settings(update)
-
-    if not changed:
-        return changed
-
-    await self._disconnect()
-    await self._connect()
-
-    return changed
-```
-
-The dict keys work like a set for membership tests (`"language" in changed`) and truthiness (`if changed`). Use `changed.keys() - {"language"}` for set difference, or `changed["language"]` to inspect the previous value of a field.
-
-Note that, in this example, the service requires a reconnect to apply the new language. Consider, for each setting, whether your service requires reconnection or can apply changes in-place.
-
-If your service can't yet apply certain settings at runtime, call `self._warn_unhandled_updated_settings(changed)` with any unhandled field names so users get a clear log message:
-
-```python
-async def _update_settings(self, update: TTSSettings) -> dict[str, Any]:
-    changed = await super()._update_settings(update)
-
-    if not changed:
-        return changed
-
-    if "language" in changed:
-        await self._update_language()
-    else:
-        # TODO: this should be temporary - handle changes to other settings soon!
-        self._warn_unhandled_updated_settings(changed.keys() - {"language"})
-
-    return changed
-```
-
-### Sample Rate Handling
-
-Sample rates are set via PipelineParams and passed to each frame processor at initialization. The pattern is to _not_ set the sample rate value in the constructor of a given service. Instead, use the `start()` method to initialize sample rates from the frame:
-
-```python
-async def start(self, frame: StartFrame):
-    """Start the service."""
-    await super().start(frame)
-    self._settings.output_sample_rate = self.sample_rate
-    await self._connect()
-```
-
-Note that `self.sample_rate` is a `@property` set in the TTSService base class, which provides access to the private sample rate value obtained from the StartFrame.
-
-### Tracing Decorators
-
-Use Pipecat's tracing decorators:
-
-- **STT:** `@traced_stt` - decorate `_handle_transcription(self, transcript, is_final, language)` (the standard method name convention)
-- **LLM:** `@traced_llm` - decorate the `_process_context()` method
-- **TTS:** `@traced_tts` - decorate the `run_tts()` method
-
-## Best Practices
-
-### Packaging and Distribution
-
-- Name your package `pipecat-{vendor}` (see [Naming Conventions](#naming-conventions))
-- Use [uv](https://docs.astral.sh/uv/) for packaging (encouraged)
-- Publish to PyPI for easier installation
-- Follow semantic versioning principles
-- Maintain a changelog
-
-### HTTP Communication
-
-For REST-based communication, use aiohttp. Pipecat includes this as a required dependency, so using it prevents adding an additional dependency to your integration.
-
-### Error Handling
-
-- Wrap API calls in appropriate try/catch blocks
-- Handle rate limits and network failures gracefully
-- Provide meaningful error messages
-- When errors occur, raise exceptions AND push errors to notify the pipeline:
-
-```python
-try:
-    # Your API call
-    result = await self._make_api_call()
-except Exception as e:
-    # Push error upstream to notify the pipeline
-    await self.push_error(f"{self} error: {e}", exception=e)
-    # Raise or handle as appropriate
-    raise
-```
-
-### Testing
-
-- Your foundational example serves as a valuable integration-level test
-- Unit tests are nice to have. As the Pipecat teams provides better guidance, we will encourage unit testing more
-
-## Disclaimer
-
-Community integrations are community-maintained and not officially supported by the Pipecat team. Users should evaluate these integrations independently. The Pipecat team reserves the right to remove listings that become unmaintained or problematic.
-
-## Staying Up to Date
-
-Pipecat evolves rapidly to support the latest AI technologies and patterns. While we strive to minimize breaking changes, they do occur as the framework matures.
-
-**We strongly recommend:**
-
-- Join our Discord at https://discord.gg/pipecat and monitor the `#announcements` channel for release notifications
-- Follow our changelog: https://github.com/pipecat-ai/pipecat/blob/main/CHANGELOG.md
-- Test your integration against new Pipecat releases promptly
-- Update your README with the last tested Pipecat version
-
-This helps ensure your integration remains compatible and your users have clear expectations about version support.
-
-## Questions?
-
-Join our Discord community at https://discord.gg/pipecat and post in the `#community-integrations` channel for guidance and support.
-
-For additional questions, you can also reach out to us at pipecat-ai@daily.co.

CONTRIBUTING.md

@@ -1,9 +1,5 @@
 ## Contributing to Pipecat
 
-**Want to add a new service integration?**
-We encourage community-maintained integrations! Please see our [Community Integration Guide](COMMUNITY_INTEGRATIONS.md) for the process and requirements.
-
-**Want to contribute to Pipecat core?**
 We welcome contributions of all kinds! Your help is appreciated. Follow these steps to get involved:
 
 1. **Fork this repository**: Start by forking the Pipecat Documentation repository to your GitHub account.
@@ -17,137 +13,24 @@ We welcome contributions of all kinds! Your help is appreciated. Follow these st
    git checkout -b your-branch-name
    ```
 4. **Make your changes**: Edit or add files as necessary.
-5. **Add a changelog entry**: Create a changelog fragment file (see [Changelog Entries](#changelog-entries) below).
-6. **Test your changes**: Ensure that your changes look correct and follow the style set in the codebase.
-7. **Commit your changes**: Once you're satisfied with your changes, commit them with a meaningful message.
+5. **Test your changes**: Ensure that your changes look correct and follow the style set in the codebase.
+6. **Commit your changes**: Once you're satisfied with your changes, commit them with a meaningful message.
 
 ```bash
 git commit -m "Description of your changes"
 ```
 
-8. **Push your changes**: Push your branch to your forked repository.
+7. **Push your changes**: Push your branch to your forked repository.
 
 ```bash
 git push origin your-branch-name
 ```
 
-9. **Submit a Pull Request (PR)**: Open a PR from your forked repository to the main branch of this repo.
+8. **Submit a Pull Request (PR)**: Open a PR from your forked repository to the main branch of this repo.
    > Important: Describe the changes you've made clearly!
 
 Our maintainers will review your PR, and once everything is good, your contributions will be merged!
 
-## Changelog Entries
-
-Every pull request that makes a user-facing change should include a changelog entry. We use a changelog fragment system to avoid merge conflicts.
-
-### Creating a Changelog Fragment
-
-1. Create a new file in the `changelog/` directory with this naming pattern:
-
-   ```
-   <PR_number>.<type>.md
-   ```
-
-2. Choose the appropriate type:
-   - `added.md` - New features
-   - `changed.md` - Changes in existing functionality
-   - `deprecated.md` - Soon-to-be removed features
-   - `removed.md` - Removed features
-   - `fixed.md` - Bug fixes
-   - `performance.md` - Performance improvements
-   - `security.md` - Security fixes
-   - `other.md` - Other changes (documentation, dependencies, etc.)
-
-3. Write your changelog entry as a Markdown bullet point. Include the `-` at the start:
-
-**Example files:**
-
-`changelog/1234.added.md`:
-
-```markdown
-- Added support for Anthropic Claude 3.5 Sonnet with improved streaming performance.
-```
-
-`changelog/5678.fixed.md`:
-
-```markdown
-- Fixed an issue where audio frames were dropped during high-load scenarios.
-```
-
-**For entries with nested bullets:**
-
-`changelog/1234.changed.md`:
-
-```markdown
-- Updated service configuration:
-  - Changed default timeout to 30 seconds
-  - Added retry logic for failed connections
-```
-
-### Multiple Changes in One PR
-
-**Different types of changes:** Create separate fragment files for each type:
-
-```
-changelog/1234.added.md
-changelog/1234.fixed.md
-```
-
-**Multiple changes of the same type:** Create numbered fragment files:
-
-```
-changelog/1234.changed.md
-changelog/1234.changed.2.md
-```
-
-**Related changes:** Use nested bullets in a single fragment:
-
-```markdown
-- Updated service configuration:
-  - Changed default timeout to 30 seconds
-  - Added retry logic for failed connections
-```
-
-**Rule of thumb:** One logical change per fragment file. If changes are unrelated, use separate files.
-
-### Preview Your Changes
-
-To see what your changelog entry will look like:
-
-```bash
-towncrier build --draft --version Unreleased
-```
-
-This won't modify any files, just show you a preview.
-
-### When to Skip Changelog Entries
-
-You can skip adding a changelog entry for:
-
-- Documentation-only changes
-- Internal refactoring with no user-facing impact
-- Test-only changes
-- CI/build configuration changes
-
-If you're unsure whether your change needs a changelog entry, ask in your PR!
-
-## Dependency Management
-
-This project uses [uv](https://docs.astral.sh/uv/) for dependency management. The `uv.lock` file is committed to ensure reproducible builds.
-
-### Adding or Updating Dependencies
-
-1. Edit `pyproject.toml` to add/update dependencies
-2. Run `uv lock` to update the lockfile with new dependency resolution
-3. Run `uv sync` to install the updated dependencies locally
-4. Always commit both files together:
-   ```bash
-   git add pyproject.toml uv.lock
-   git commit -m "feat: add new dependency for feature X"
-   ```
-
-**Important:** Never manually edit `uv.lock`. It's auto-generated by `uv lock`.
-
 ## Code Style and Documentation
 
 ### Python Code Style
@@ -158,150 +41,36 @@ We use Ruff for code linting and formatting. Please ensure your code passes all
 
 We follow Google-style docstrings with these specific conventions:
 
-**Regular Classes:**
+- Class docstrings should fully document all parameters used in `__init__`
+- We don't require separate docstrings for `__init__` methods when parameters are documented in the class docstring
+- Property methods should have docstrings explaining their purpose and return value
 
-- Class docstring describes the class purpose and key functionality
-- `__init__` method has its own docstring with complete `Args:` section documenting all parameters
-- All public methods must have docstrings with `Args:` and `Returns:` sections as appropriate
-
-**Dataclasses:**
-
-- Class docstring describes the purpose and documents all fields in a `Parameters:` section
-- No `__init__` docstring (auto-generated)
-
-**Properties:**
-
-- Must have docstrings with `Returns:` section
-
-**Abstract Methods:**
-
-- Must have docstrings explaining what subclasses should implement
-
-**`__init__.py` Files:**
-
-- **Skip docstrings** for pure import/re-export modules
-- **Add brief docstrings** for top-level packages or those with initialization logic
-
-**Enums:**
-
-- Class docstring describes the enumeration purpose
-- Use `Parameters:` section to document each enum value and its meaning
-- No `__init__` docstring (Enums don't have custom constructors)
-
-**Code Examples in Docstrings:**
-
-- Use `Examples:` as a section header for multiple examples
-- Use descriptive text followed by double colons (`::`) for each example
-- **Always include a blank line after the `::"`**
-- Indent all code consistently within each block
-- Separate multiple examples with blank lines for readability
-
-**Lists and Bullets in Docstrings:**
-
-- Use dashes (`-`) for bullet points, not asterisks (`*`)
-- **Add a blank line before bullet lists** when they follow a colon
-- Use section headers like "Supported features:" or "Behavior:" before lists
-- For complex nested information, consider using paragraph format instead
-
-**Deprecations:**
-
-- Use `warnings.warn()` in code for runtime deprecation warnings
-- Add `.. deprecated::` directive in docstrings for documentation visibility
-- Include version information and describe current status
-- Describe parameters in present tense, use directive to indicate deprecation status
-
-#### Examples:
+Example of correctly documented class:
 
 ```python
-# Regular class
-class MyService(BaseService):
-    """Description of what the service does.
+class MyClass:
+    """Class description.
 
-    Provides detailed explanation of the service's functionality,
-    key features, and usage patterns.
+    Additional details about the class.
 
-    Supported features:
-
-    - Feature one with detailed explanation
-    - Feature two with additional context
-    - Feature three for advanced use cases
+    Args:
+        param1: Description of first parameter.
+        param2: Description of second parameter.
     """
 
-    def __init__(self, param1: str, old_param: str = None, **kwargs):
-        """Initialize the service.
-
-        Args:
-            param1: Description of param1.
-            old_param: Controls legacy behavior.
-
-                .. deprecated:: 1.2.0
-                    This parameter no longer has any effect and will be removed in version 2.0.
-
-            **kwargs: Additional arguments passed to parent.
-        """
-        if old_param is not None:
-            import warnings
-            warnings.warn(
-                "Parameter 'old_param' is deprecated and will be removed in version 2.0.",
-                DeprecationWarning,
-            )
-        super().__init__(**kwargs)
+    def __init__(self, param1, param2):
+        # No docstring required here as parameters are documented above
+        self.param1 = param1
+        self.param2 = param2
 
     @property
-    def sample_rate(self) -> int:
-        """Get the current sample rate.
+    def some_property(self) -> str:
+        """Get the formatted property value.
 
         Returns:
-            The sample rate in Hz.
+            A string representation of the property.
         """
-        return self._sample_rate
-
-    async def process_data(self, data: str) -> bool:
-        """Process the provided data.
-
-        Args:
-            data: The data to process.
-
-        Returns:
-            True if processing succeeded.
-        """
-        pass
-
-# Dataclass with code examples
-@dataclass
-class MessageFrame:
-    """Frame containing messages in OpenAI format.
-
-    Supports both simple and content list message formats.
-
-    Example::
-
-        [
-            {"role": "user", "content": "Hello"},
-            {"role": "assistant", "content": "Hi there!"}
-        ]
-
-    Parameters:
-        messages: List of messages in OpenAI format.
-    """
-
-    messages: List[dict]
-
-# Enum class
-class Status(Enum):
-    """Status codes for processing operations.
-
-    Parameters:
-        PENDING: Operation is queued but not started.
-        RUNNING: Operation is currently in progress.
-        COMPLETED: Operation finished successfully.
-        FAILED: Operation encountered an error.
-    """
-
-    PENDING = "pending"
-    RUNNING = "running"
-    COMPLETED = "completed"
-    FAILED = "failed"
+        return f"Property: {self.param1}"
 ```
 
 # Contributor Covenant Code of Conduct

Dockerfile

@@ -0,0 +1,40 @@
+# setup
+FROM python:3.11.5
+
+WORKDIR /app
+COPY requirements.txt /app
+COPY *.py /app
+COPY pyproject.toml /app
+
+COPY src/ /app/src/
+COPY examples/ /app/examples/
+
+WORKDIR /app
+RUN ls --recursive /app/
+RUN pip3 install --upgrade -r requirements.txt
+RUN python -m build .
+RUN pip3 install .
+RUN pip3 install gunicorn
+# If running on Ubuntu, Azure TTS requires some extra config
+# https://learn.microsoft.com/en-us/azure/ai-services/speech-service/quickstarts/setup-platform?pivots=programming-language-python&tabs=linux%2Cubuntu%2Cdotnetcli%2Cdotnet%2Cjre%2Cmaven%2Cnodejs%2Cmac%2Cpypi
+
+RUN wget -O - https://www.openssl.org/source/openssl-1.1.1w.tar.gz | tar zxf -
+WORKDIR openssl-1.1.1w
+RUN ./config --prefix=/usr/local
+RUN make -j $(nproc)
+RUN make install_sw install_ssldirs
+RUN ldconfig -v
+ENV SSL_CERT_DIR=/etc/ssl/certs
+
+#ENV LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
+RUN apt clean
+RUN apt-get update
+RUN apt-get -y install build-essential libssl-dev ca-certificates libasound2 wget
+
+ENV PYTHONUNBUFFERED=1
+
+WORKDIR /app
+
+EXPOSE 8000
+# run
+CMD ["gunicorn", "--workers=2", "--log-level", "debug", "--chdir", "examples/server", "--capture-output", "daily-bot-manager:app", "--bind=0.0.0.0:8000"]

LICENSE

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2024–2026, Daily
+Copyright (c) 2024–2025, Daily
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

MANIFEST.in

@@ -1,4 +0,0 @@
-prune docs
-prune examples
-prune scripts
-prune tests

README.md

@@ -2,14 +2,12 @@
  <img alt="pipecat" width="300px" height="auto" src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/pipecat.png">
 </div></h1>
 
-[![PyPI](https://img.shields.io/pypi/v/pipecat-ai)](https://pypi.org/project/pipecat-ai) ![Tests](https://github.com/pipecat-ai/pipecat/actions/workflows/tests.yaml/badge.svg) [![codecov](https://codecov.io/gh/pipecat-ai/pipecat/graph/badge.svg?token=LNVUIVO4Y9)](https://codecov.io/gh/pipecat-ai/pipecat) [![Docs](https://img.shields.io/badge/Documentation-blue)](https://docs.pipecat.ai) [![Discord](https://img.shields.io/discord/1239284677165056021)](https://discord.gg/pipecat) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/pipecat-ai/pipecat)
+[![PyPI](https://img.shields.io/pypi/v/pipecat-ai)](https://pypi.org/project/pipecat-ai) ![Tests](https://github.com/pipecat-ai/pipecat/actions/workflows/tests.yaml/badge.svg) [![codecov](https://codecov.io/gh/pipecat-ai/pipecat/graph/badge.svg?token=LNVUIVO4Y9)](https://codecov.io/gh/pipecat-ai/pipecat) [![Docs](https://img.shields.io/badge/Documentation-blue)](https://docs.pipecat.ai) [![Discord](https://img.shields.io/discord/1239284677165056021)](https://discord.gg/pipecat)
 
 # 🎙️ Pipecat: Real-Time Voice & Multimodal AI Agents
 
 **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? Run `pipecat init quickstart` or follow the [quickstart guide](https://docs.pipecat.ai/getting-started/quickstart).
-
 ## 🚀 What You Can Build
 
 - **Voice Assistants** – natural, streaming conversations with AI
@@ -19,6 +17,8 @@
 - **Business Agents** – customer intake, support bots, guided flows
 - **Complex Dialog Systems** – design logic with structured conversations
 
+🧭 Looking to build structured conversations? Check out [Pipecat Flows](https://github.com/pipecat-ai/pipecat-flows) for managing complex conversational states and transitions.
+
 ## 🧠 Why Pipecat?
 
 - **Voice-first**: Integrates speech recognition, text-to-speech, and conversation handling
@@ -26,184 +26,170 @@
 - **Composable Pipelines**: Build complex behavior from modular components
 - **Real-Time**: Ultra-low latency interaction with different transports (e.g. WebSockets or WebRTC)
 
-## 🌐 Pipecat Ecosystem
-
-### 🧩 Multi-agent systems
-
-Need multiple AI agents working together? [Pipecat Subagents](https://github.com/pipecat-ai/pipecat-subagents) lets you build distributed multi-agent systems where each agent runs its own pipeline and communicates through a shared message bus. Hand off conversations between specialists, dispatch background tasks, and scale agents across processes or machines.
-
-### 📱 Client SDKs
-
-Building client applications? You can connect to Pipecat from any platform using our official SDKs:
-
-<a href="https://docs.pipecat.ai/client/js/introduction">JavaScript</a> | <a href="https://docs.pipecat.ai/client/react/introduction">React</a> | <a href="https://docs.pipecat.ai/client/react-native/introduction">React Native</a> |
-<a href="https://docs.pipecat.ai/client/ios/introduction">Swift</a> | <a href="https://docs.pipecat.ai/client/android/introduction">Kotlin</a> | <a href="https://docs.pipecat.ai/client/c++/introduction">C++</a> | <a href="https://github.com/pipecat-ai/pipecat-esp32">ESP32</a>
-
-### 🧭 Structured conversations
-
-Looking to build structured conversations? Check out [Pipecat Flows](https://github.com/pipecat-ai/pipecat-flows) for managing complex conversational states and transitions.
-
-### 🪄 Beautiful UIs
-
-Want to build beautiful and engaging experiences? Checkout the [Voice UI Kit](https://github.com/pipecat-ai/voice-ui-kit), a collection of components, hooks and templates for building voice AI applications quickly.
-
-### 🛠️ Create and deploy projects
-
-Create a new project in under a minute with the [Pipecat CLI](https://github.com/pipecat-ai/pipecat-cli). Then use the CLI to monitor and deploy your agent to production.
-
-### 🔍 Debugging
-
-Looking for help debugging your pipeline and processors? Check out [Whisker](https://github.com/pipecat-ai/whisker), a real-time Pipecat debugger.
-
-### 🖥️ Terminal
-
-Love terminal applications? Check out [Tail](https://github.com/pipecat-ai/tail), a terminal dashboard for Pipecat.
-
-### 🤖 Claude Code Skills
-
-Use [Pipecat Skills](https://github.com/pipecat-ai/skills) with [Claude Code](https://claude.ai/code) to scaffold projects, deploy to Pipecat Cloud, and more. Install the marketplace with:
-
-```
-claude plugin marketplace add pipecat-ai/skills
-```
-
-and install any of the available plugins.
-
-### 🧩 Community Integrations
-
-Build and share your own Pipecat service integrations! Browse existing [community integrations](https://docs.pipecat.ai/api-reference/server/services/community-integrations) or check out our [guide](COMMUNITY_INTEGRATIONS.md) to create your own.
-
-### 📺️ Pipecat TV Channel
-
-Catch new features, interviews, and how-tos on our [Pipecat TV](https://www.youtube.com/playlist?list=PLzU2zoMTQIHjqC3v4q2XVSR3hGSzwKFwH) channel.
-
 ## 🎬 See it in action
 
 <p float="left">
-    <a href="https://github.com/pipecat-ai/pipecat-examples/tree/main/simple-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat-examples/main/simple-chatbot/image.png" width="400" /></a>&nbsp;
-    <a href="https://github.com/pipecat-ai/pipecat-examples/tree/main/storytelling-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat-examples/main/storytelling-chatbot/image.png" width="400" /></a>
+    <a href="https://github.com/pipecat-ai/pipecat/tree/main/examples/simple-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/examples/simple-chatbot/image.png" width="400" /></a>&nbsp;
+    <a href="https://github.com/pipecat-ai/pipecat/tree/main/examples/storytelling-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/examples/storytelling-chatbot/image.png" width="400" /></a>
     <br/>
-    <a href="https://github.com/pipecat-ai/pipecat-examples/tree/main/daily-multi-translation"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat-examples/main/daily-multi-translation/image.png" width="400" /></a>&nbsp;
-    <a href="https://github.com/pipecat-ai/pipecat/blob/main/examples/vision/vision-moondream.py"><img src="https://github.com/pipecat-ai/pipecat/blob/main/examples/assets/moondream.png" width="400" /></a>
+    <a href="https://github.com/pipecat-ai/pipecat/tree/main/examples/translation-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/examples/translation-chatbot/image.png" width="400" /></a>&nbsp;
+    <a href="https://github.com/pipecat-ai/pipecat/tree/main/examples/moondream-chatbot"><img src="https://raw.githubusercontent.com/pipecat-ai/pipecat/main/examples/moondream-chatbot/image.png" width="400" /></a>
 </p>
 
+## 📱 Client SDKs
+
+You can connect to Pipecat from any platform using our official SDKs:
+
+| Platform | SDK Repo                                                                       | Description                      |
+| -------- | ------------------------------------------------------------------------------ | -------------------------------- |
+| Web      | [pipecat-client-web](https://github.com/pipecat-ai/pipecat-client-web)         | JavaScript and React client SDKs |
+| iOS      | [pipecat-client-ios](https://github.com/pipecat-ai/pipecat-client-ios)         | Swift SDK for iOS                |
+| Android  | [pipecat-client-android](https://github.com/pipecat-ai/pipecat-client-android) | Kotlin SDK for Android           |
+| C++      | [pipecat-client-cxx](https://github.com/pipecat-ai/pipecat-client-cxx)         | C++ client SDK                   |
+
 ## 🧩 Available services
 
-| Category            | Services                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
-| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Speech-to-Text      | [AssemblyAI](https://docs.pipecat.ai/api-reference/server/services/stt/assemblyai), [AWS](https://docs.pipecat.ai/api-reference/server/services/stt/aws), [Azure](https://docs.pipecat.ai/api-reference/server/services/stt/azure), [Cartesia](https://docs.pipecat.ai/api-reference/server/services/stt/cartesia), [Deepgram](https://docs.pipecat.ai/api-reference/server/services/stt/deepgram), [ElevenLabs](https://docs.pipecat.ai/api-reference/server/services/stt/elevenlabs), [Fal Wizper](https://docs.pipecat.ai/api-reference/server/services/stt/fal), [Gladia](https://docs.pipecat.ai/api-reference/server/services/stt/gladia), [Google](https://docs.pipecat.ai/api-reference/server/services/stt/google), [Gradium](https://docs.pipecat.ai/api-reference/server/services/stt/gradium), [Groq (Whisper)](https://docs.pipecat.ai/api-reference/server/services/stt/groq), [Mistral](https://docs.pipecat.ai/api-reference/server/services/stt/mistral), [NVIDIA](https://docs.pipecat.ai/api-reference/server/services/stt/nvidia), [OpenAI (Whisper)](https://docs.pipecat.ai/api-reference/server/services/stt/openai), [Sarvam](https://docs.pipecat.ai/api-reference/server/services/stt/sarvam), [Soniox](https://docs.pipecat.ai/api-reference/server/services/stt/soniox), [Speechmatics](https://docs.pipecat.ai/api-reference/server/services/stt/speechmatics), [Whisper](https://docs.pipecat.ai/api-reference/server/services/stt/whisper), [xAI](https://docs.pipecat.ai/api-reference/server/services/stt/xai)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
-| LLMs                | [Anthropic](https://docs.pipecat.ai/api-reference/server/services/llm/anthropic), [AWS](https://docs.pipecat.ai/api-reference/server/services/llm/aws), [Azure](https://docs.pipecat.ai/api-reference/server/services/llm/azure), [Cerebras](https://docs.pipecat.ai/api-reference/server/services/llm/cerebras), [DeepSeek](https://docs.pipecat.ai/api-reference/server/services/llm/deepseek), [Fireworks AI](https://docs.pipecat.ai/api-reference/server/services/llm/fireworks), [Gemini](https://docs.pipecat.ai/api-reference/server/services/llm/gemini), [Grok](https://docs.pipecat.ai/api-reference/server/services/llm/grok), [Groq](https://docs.pipecat.ai/api-reference/server/services/llm/groq), [Mistral](https://docs.pipecat.ai/api-reference/server/services/llm/mistral), [Nebius](https://docs.pipecat.ai/api-reference/server/services/llm/nebius), [Novita](https://docs.pipecat.ai/api-reference/server/services/llm/novita), [NVIDIA NIM](https://docs.pipecat.ai/api-reference/server/services/llm/nvidia), [Ollama](https://docs.pipecat.ai/api-reference/server/services/llm/ollama), [OpenAI](https://docs.pipecat.ai/api-reference/server/services/llm/openai), [OpenAI Responses](https://docs.pipecat.ai/api-reference/server/services/llm/openai-responses), [OpenRouter](https://docs.pipecat.ai/api-reference/server/services/llm/openrouter), [Perplexity](https://docs.pipecat.ai/api-reference/server/services/llm/perplexity), [Qwen](https://docs.pipecat.ai/api-reference/server/services/llm/qwen), [SambaNova](https://docs.pipecat.ai/api-reference/server/services/llm/sambanova), [Sarvam](https://docs.pipecat.ai/api-reference/server/services/llm/sarvam), [Together AI](https://docs.pipecat.ai/api-reference/server/services/llm/together)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
-| Text-to-Speech      | [Async](https://docs.pipecat.ai/api-reference/server/services/tts/asyncai), [AWS](https://docs.pipecat.ai/api-reference/server/services/tts/aws), [Azure](https://docs.pipecat.ai/api-reference/server/services/tts/azure), [Camb AI](https://docs.pipecat.ai/api-reference/server/services/tts/camb), [Cartesia](https://docs.pipecat.ai/api-reference/server/services/tts/cartesia), [Deepgram](https://docs.pipecat.ai/api-reference/server/services/tts/deepgram), [ElevenLabs](https://docs.pipecat.ai/api-reference/server/services/tts/elevenlabs), [Fish](https://docs.pipecat.ai/api-reference/server/services/tts/fish), [Google](https://docs.pipecat.ai/api-reference/server/services/tts/google), [Gradium](https://docs.pipecat.ai/api-reference/server/services/tts/gradium), [Groq](https://docs.pipecat.ai/api-reference/server/services/tts/groq), [Hume](https://docs.pipecat.ai/api-reference/server/services/tts/hume), [Inworld](https://docs.pipecat.ai/api-reference/server/services/tts/inworld), [Kokoro](https://docs.pipecat.ai/api-reference/server/services/tts/kokoro), [LMNT](https://docs.pipecat.ai/api-reference/server/services/tts/lmnt), [MiniMax](https://docs.pipecat.ai/api-reference/server/services/tts/minimax), [Mistral](https://docs.pipecat.ai/api-reference/server/services/tts/mistral), [Neuphonic](https://docs.pipecat.ai/api-reference/server/services/tts/neuphonic), [NVIDIA](https://docs.pipecat.ai/api-reference/server/services/tts/nvidia), [OpenAI](https://docs.pipecat.ai/api-reference/server/services/tts/openai), [Piper](https://docs.pipecat.ai/api-reference/server/services/tts/piper), [Resemble](https://docs.pipecat.ai/api-reference/server/services/tts/resemble), [Rime](https://docs.pipecat.ai/api-reference/server/services/tts/rime), [Sarvam](https://docs.pipecat.ai/api-reference/server/services/tts/sarvam), [Smallest](https://docs.pipecat.ai/api-reference/server/services/tts/smallest), [Soniox](https://docs.pipecat.ai/api-reference/server/services/tts/soniox), [Speechmatics](https://docs.pipecat.ai/api-reference/server/services/tts/speechmatics), [xAI](https://docs.pipecat.ai/api-reference/server/services/tts/xai), [XTTS](https://docs.pipecat.ai/api-reference/server/services/tts/xtts) |
-| Speech-to-Speech    | [AWS Nova Sonic](https://docs.pipecat.ai/api-reference/server/services/s2s/aws), [Gemini Multimodal Live](https://docs.pipecat.ai/api-reference/server/services/s2s/gemini), [Grok Voice Agent](https://docs.pipecat.ai/api-reference/server/services/s2s/grok), [OpenAI Realtime](https://docs.pipecat.ai/api-reference/server/services/s2s/openai), [Ultravox](https://docs.pipecat.ai/api-reference/server/services/s2s/ultravox),                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
-| Transport           | [Daily (WebRTC)](https://docs.pipecat.ai/api-reference/server/services/transport/daily), [FastAPI Websocket](https://docs.pipecat.ai/api-reference/server/services/transport/fastapi-websocket), [LiveKit (WebRTC)](https://docs.pipecat.ai/api-reference/server/services/transport/livekit), [SmallWebRTCTransport](https://docs.pipecat.ai/api-reference/server/services/transport/small-webrtc), [WebSocket Server](https://docs.pipecat.ai/api-reference/server/services/transport/websocket-server), [WhatsApp](https://docs.pipecat.ai/api-reference/server/services/transport/whatsapp), Local                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
-| Serializers         | [Exotel](https://docs.pipecat.ai/api-reference/server/services/serializers/exotel), [Genesys](https://docs.pipecat.ai/api-reference/server/services/serializers/genesys), [Plivo](https://docs.pipecat.ai/api-reference/server/services/serializers/plivo), [Twilio](https://docs.pipecat.ai/api-reference/server/services/serializers/twilio), [Telnyx](https://docs.pipecat.ai/api-reference/server/services/serializers/telnyx), [Vonage](https://docs.pipecat.ai/api-reference/server/services/serializers/vonage)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
-| Video               | [HeyGen](https://docs.pipecat.ai/api-reference/server/services/video/heygen), [LemonSlice](https://docs.pipecat.ai/api-reference/server/services/transport/lemonslice), [Tavus](https://docs.pipecat.ai/api-reference/server/services/video/tavus), [Simli](https://docs.pipecat.ai/api-reference/server/services/video/simli)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
-| Memory              | [mem0](https://docs.pipecat.ai/api-reference/server/services/memory/mem0)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| Vision & Image      | [fal](https://docs.pipecat.ai/api-reference/server/services/image-generation/fal), [Google Imagen](https://docs.pipecat.ai/api-reference/server/services/image-generation/google-imagen), [Moondream](https://docs.pipecat.ai/api-reference/server/services/vision/moondream)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
-| Audio Processing    | [Silero VAD](https://docs.pipecat.ai/api-reference/server/utilities/audio/silero-vad-analyzer), [Krisp Viva](https://docs.pipecat.ai/guides/features/krisp-viva), [Koala](https://docs.pipecat.ai/api-reference/server/utilities/audio/koala-filter), [ai-coustics](https://docs.pipecat.ai/api-reference/server/utilities/audio/aic-filter), [RNNoise](https://docs.pipecat.ai/api-reference/server/utilities/audio/rnnoise-filter)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| Analytics & Metrics | [OpenTelemetry](https://docs.pipecat.ai/api-reference/server/utilities/opentelemetry), [Sentry](https://docs.pipecat.ai/api-reference/server/services/analytics/sentry)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| Community           | [Browse community integrations →](https://docs.pipecat.ai/api-reference/server/services/community-integrations)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| Category            | Services                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Speech-to-Text      | [AssemblyAI](https://docs.pipecat.ai/server/services/stt/assemblyai), [AWS](https://docs.pipecat.ai/server/services/stt/aws), [Azure](https://docs.pipecat.ai/server/services/stt/azure), [Deepgram](https://docs.pipecat.ai/server/services/stt/deepgram), [Fal Wizper](https://docs.pipecat.ai/server/services/stt/fal), [Gladia](https://docs.pipecat.ai/server/services/stt/gladia), [Google](https://docs.pipecat.ai/server/services/stt/google), [Groq (Whisper)](https://docs.pipecat.ai/server/services/stt/groq), [OpenAI (Whisper)](https://docs.pipecat.ai/server/services/stt/openai), [Parakeet (NVIDIA)](https://docs.pipecat.ai/server/services/stt/parakeet), [Ultravox](https://docs.pipecat.ai/server/services/stt/ultravox), [Whisper](https://docs.pipecat.ai/server/services/stt/whisper)                                                                                                                                                                                                                                            |
+| LLMs                | [Anthropic](https://docs.pipecat.ai/server/services/llm/anthropic), [AWS](https://docs.pipecat.ai/server/services/llm/aws), [Azure](https://docs.pipecat.ai/server/services/llm/azure), [Cerebras](https://docs.pipecat.ai/server/services/llm/cerebras), [DeepSeek](https://docs.pipecat.ai/server/services/llm/deepseek), [Fireworks AI](https://docs.pipecat.ai/server/services/llm/fireworks), [Gemini](https://docs.pipecat.ai/server/services/llm/gemini), [Grok](https://docs.pipecat.ai/server/services/llm/grok), [Groq](https://docs.pipecat.ai/server/services/llm/groq), [NVIDIA NIM](https://docs.pipecat.ai/server/services/llm/nim), [Ollama](https://docs.pipecat.ai/server/services/llm/ollama), [OpenAI](https://docs.pipecat.ai/server/services/llm/openai), [OpenRouter](https://docs.pipecat.ai/server/services/llm/openrouter), [Perplexity](https://docs.pipecat.ai/server/services/llm/perplexity), [Qwen](https://docs.pipecat.ai/server/services/llm/qwen), [Together AI](https://docs.pipecat.ai/server/services/llm/together) |
+| Text-to-Speech      | [AWS](https://docs.pipecat.ai/server/services/tts/aws), [Azure](https://docs.pipecat.ai/server/services/tts/azure), [Cartesia](https://docs.pipecat.ai/server/services/tts/cartesia), [Deepgram](https://docs.pipecat.ai/server/services/tts/deepgram), [ElevenLabs](https://docs.pipecat.ai/server/services/tts/elevenlabs), [FastPitch (NVIDIA)](https://docs.pipecat.ai/server/services/tts/fastpitch), [Fish](https://docs.pipecat.ai/server/services/tts/fish), [Google](https://docs.pipecat.ai/server/services/tts/google), [LMNT](https://docs.pipecat.ai/server/services/tts/lmnt), [Neuphonic](https://docs.pipecat.ai/server/services/tts/neuphonic), [OpenAI](https://docs.pipecat.ai/server/services/tts/openai), [Piper](https://docs.pipecat.ai/server/services/tts/piper), [PlayHT](https://docs.pipecat.ai/server/services/tts/playht), [Rime](https://docs.pipecat.ai/server/services/tts/rime), [XTTS](https://docs.pipecat.ai/server/services/tts/xtts)                                                                               |
+| Speech-to-Speech    | [Gemini Multimodal Live](https://docs.pipecat.ai/server/services/s2s/gemini), [OpenAI Realtime](https://docs.pipecat.ai/server/services/s2s/openai)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| Transport           | [Daily (WebRTC)](https://docs.pipecat.ai/server/services/transport/daily), [FastAPI Websocket](https://docs.pipecat.ai/server/services/transport/fastapi-websocket), [SmallWebRTCTransport](https://docs.pipecat.ai/server/services/transport/small-webrtc), [WebSocket Server](https://docs.pipecat.ai/server/services/transport/websocket-server), Local                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| Video               | [Tavus](https://docs.pipecat.ai/server/services/video/tavus), [Simli](https://docs.pipecat.ai/server/services/video/simli)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| Memory              | [mem0](https://docs.pipecat.ai/server/services/memory/mem0)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| Vision & Image      | [fal](https://docs.pipecat.ai/server/services/image-generation/fal), [Google Imagen](https://docs.pipecat.ai/server/services/image-generation/fal), [Moondream](https://docs.pipecat.ai/server/services/vision/moondream)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| Audio Processing    | [Silero VAD](https://docs.pipecat.ai/server/utilities/audio/silero-vad-analyzer), [Krisp](https://docs.pipecat.ai/server/utilities/audio/krisp-filter), [Koala](https://docs.pipecat.ai/server/utilities/audio/koala-filter), [Noisereduce](https://docs.pipecat.ai/server/utilities/audio/noisereduce-filter)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| Analytics & Metrics | [Sentry](https://docs.pipecat.ai/server/services/analytics/sentry)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
-📚 [View full services documentation →](https://docs.pipecat.ai/api-reference/server/services/supported-services)
+📚 [View full services documentation →](https://docs.pipecat.ai/server/services/supported-services)
 
 ## ⚡ Getting started
 
-You can get started with Pipecat running on your local machine, then move your agent processes to the cloud when you're ready.
+You can get started with Pipecat running on your local machine, then move your agent processes to the cloud when you’re ready.
 
-1. Install uv
+```shell
+# Install the module
+pip install pipecat-ai
 
-   ```bash
-   curl -LsSf https://astral.sh/uv/install.sh | sh
-   ```
+# Set up your environment
+cp dot-env.template .env
+```
 
-   > **Need help?** Refer to the [uv install documentation](https://docs.astral.sh/uv/getting-started/installation/).
+To keep things lightweight, only the core framework is included by default. If you need support for third-party AI services, you can add the necessary dependencies with:
 
-2. Install the module
-
-   ```bash
-   # For new projects
-   uv init my-pipecat-app
-   cd my-pipecat-app
-   uv add pipecat-ai
-
-   # Or for existing projects
-   uv add pipecat-ai
-   ```
-
-3. Set up your environment
-
-   ```bash
-   cp env.example .env
-   ```
-
-4. To keep things lightweight, only the core framework is included by default. If you need support for third-party AI services, you can add the necessary dependencies with:
-
-   ```bash
-   uv add "pipecat-ai[option,...]"
-   ```
-
-> **Using pip?** You can still use `pip install pipecat-ai` and `pip install "pipecat-ai[option,...]"` to get set up.
+```shell
+pip install "pipecat-ai[option,...]"
+```
 
 ## 🧪 Code examples
 
-- [Foundational](https://github.com/pipecat-ai/pipecat/tree/main/examples) — small snippets that build on each other, introducing one or two concepts at a time
-- [Example apps](https://github.com/pipecat-ai/pipecat-examples) — complete applications that you can use as starting points for development
+- [Foundational](https://github.com/pipecat-ai/pipecat/tree/main/examples/foundational) — small snippets that build on each other, introducing one or two concepts at a time
+- [Example apps](https://github.com/pipecat-ai/pipecat/tree/main/examples/) — complete applications that you can use as starting points for development
 
-## 🛠️ Contributing to the framework
+## 🛠️ Hacking on the framework itself
 
-### Prerequisites
+1. Set up a virtual environment before following these instructions. From the root of the repo:
 
-**Minimum Python Version:** 3.11
-**Recommended Python Version:** >= 3.12
-
-### Setup Steps
-
-1. Clone the repository and navigate to it:
-
-   ```bash
-   git clone https://github.com/pipecat-ai/pipecat.git
-   cd pipecat
+   ```shell
+   python3 -m venv venv
+   source venv/bin/activate
    ```
 
-2. Install development and testing dependencies:
+2. Install the development dependencies:
 
-   ```bash
-   uv sync --group dev --all-extras \
-     --no-extra gstreamer \
-     --no-extra local \
+   ```shell
+   pip install -r dev-requirements.txt
    ```
 
-3. Install the git pre-commit hooks:
+3. Install the git pre-commit hooks (these help ensure your code follows project rules):
 
-   ```bash
-   uv run pre-commit install
+   ```shell
+   pre-commit install
    ```
 
-> **Note**: Some extras (local, gstreamer) require system dependencies. See documentation if you encounter build errors.
+4. Install the `pipecat-ai` package locally in editable mode:
 
-### Claude Code Skills
+   ```shell
+   pip install -e .
+   ```
 
-Install development workflow skills for contributing to Pipecat with [Claude Code](https://claude.ai/code):
+   > The `-e` or `--editable` option allows you to modify the code without reinstalling.
 
-```
-claude plugin marketplace add pipecat-ai/pipecat
-claude plugin install pipecat-dev@pipecat-dev-skills
-```
+5. Include optional dependencies as needed. For example:
+
+   ```shell
+   pip install -e ".[daily,deepgram,cartesia,openai,silero]"
+   ```
+
+6. (Optional) If you want to use this package from another directory:
+
+   ```shell
+   pip install "path_to_this_repo[option,...]"
+   ```
 
 ### Running tests
 
-To run all tests, from the root directory:
+Install the test dependencies:
 
-```bash
-uv run pytest
+```shell
+pip install -r test-requirements.txt
 ```
 
-Run a specific test suite:
+From the root directory, run:
 
-```bash
-uv run pytest tests/test_name.py
+```shell
+pytest
 ```
 
+### Setting up your editor
+
+This project uses strict [PEP 8](https://peps.python.org/pep-0008/) formatting via [Ruff](https://github.com/astral-sh/ruff).
+
+#### Emacs
+
+You can use [use-package](https://github.com/jwiegley/use-package) to install [emacs-lazy-ruff](https://github.com/christophermadsen/emacs-lazy-ruff) package and configure `ruff` arguments:
+
+```elisp
+(use-package lazy-ruff
+  :ensure t
+  :hook ((python-mode . lazy-ruff-mode))
+  :config
+  (setq lazy-ruff-format-command "ruff format")
+  (setq lazy-ruff-check-command "ruff check --select I"))
+```
+
+`ruff` was installed in the `venv` environment described before, so you should be able to use [pyvenv-auto](https://github.com/ryotaro612/pyvenv-auto) to automatically load that environment inside Emacs.
+
+```elisp
+(use-package pyvenv-auto
+  :ensure t
+  :defer t
+  :hook ((python-mode . pyvenv-auto-run)))
+```
+
+#### Visual Studio Code
+
+Install the
+[Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff) extension. Then edit the user settings (_Ctrl-Shift-P_ `Open User Settings (JSON)`) and set it as the default Python formatter, and enable formatting on save:
+
+```json
+"[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true
+}
+```
+
+#### PyCharm
+
+`ruff` was installed in the `venv` environment described before, now to enable autoformatting on save, go to `File` -> `Settings` -> `Tools` -> `File Watchers` and add a new watcher with the following settings:
+
+1. **Name**: `Ruff formatter`
+2. **File type**: `Python`
+3. **Working directory**: `$ContentRoot$`
+4. **Arguments**: `format $FilePath$`
+5. **Program**: `$PyInterpreterDirectory$/ruff`
+
 ## 🤝 Contributing
 
 We welcome contributions from the community! Whether you're fixing bugs, improving documentation, or adding new features, here's how you can help:

SECURITY.md

@@ -1,5 +0,0 @@
-# Security Policy
-
-## Reporting a Vulnerability
-
-Please email `disclosures@daily.co`.

changelog/4385.added.md

@@ -1 +0,0 @@
-- Added a `session_id` field to `RunnerArguments` so bots can log or trace a per-session identifier in local development the same way they can in Pipecat Cloud. The development runner now mints a UUID at every construction site, and paths that already returned a `sessionId` to the caller (Daily `/start`, dial-in webhook) share that same UUID with the runner args instead of generating two. The SmallWebRTC `/api/offer` endpoint also accepts an optional `session_id` query parameter so the `/sessions/{session_id}/...` proxy can thread it through.

changelog/4386.changed.md

@@ -1 +0,0 @@
-- Updated the default `SonioxTTSService` model from `tts-rt-v1-preview` to the generally available `tts-rt-v1`.

changelog/4390.added.md

@@ -1 +0,0 @@
-- Added a `max_buffer_delay_ms` constructor argument to `CartesiaTTSService` for controlling Cartesia's server-side text buffering. When unset, Pipecat picks a sensible default based on `text_aggregation_mode`: `0` in `SENTENCE` mode (custom buffering — avoids stacking client-side aggregation on top of Cartesia's default 3000ms server buffer) and unset in `TOKEN` mode (Cartesia's managed buffering applies). Pass an explicit value (0–5000ms) to override.

changelog/4390.changed.2.md

@@ -1 +0,0 @@
-- Default `cartesia_version` for `CartesiaTTSService` bumped from `2025-04-16` to `2026-03-01`, matching `CartesiaHttpTTSService` and unlocking the `use_normalized_timestamps` and `max_buffer_delay_ms` fields.

changelog/4390.changed.md

@@ -1 +0,0 @@
-- ⚠️ `CartesiaTTSService` now sends `use_normalized_timestamps: true` instead of the deprecated `use_original_timestamps` field. Word timestamps now reflect what was actually spoken (post text-normalization and pronunciation-dictionary substitution), matching the convention Pipecat uses for ElevenLabs. This is a behavior change for `sonic-3` users, who were previously receiving timestamps tied to the input transcript.

changelog/4390.fixed.2.md

@@ -1 +0,0 @@
-- Fixed `CartesiaHttpTTSService` pushing two `ErrorFrame`s on a non-200 response — one with the API's error text and a second, less informative "Unknown error" frame from the outer exception handler. It now pushes a single frame that includes the HTTP status code and returns cleanly.

changelog/4390.fixed.3.md

@@ -1 +0,0 @@
-- Fixed Cartesia tag helpers (`SPELL`, `EMOTION_TAG`, `PAUSE_TAG`, `VOLUME_TAG`, `SPEED_TAG`) raising `TypeError` when called on an instance (e.g. `tts.SPELL("hi")`). They're now `@staticmethod` and callable from both the class and an instance.

changelog/4390.fixed.md

@@ -1 +0,0 @@
-- Fixed `CartesiaTTSService` surfacing `flush_done` messages from Cartesia as `ErrorFrame`s. The latest API emits a `flush_done` per transcript when server-side buffering is disabled; Pipecat now consumes them silently since each turn already has its own `context_id`.

changelog/4393.fixed.md

@@ -1 +0,0 @@
-- Fixed an issue where `LocalSmartTurnAnalyzerV3` was imported unconditionally for user turn stop strategies. It is now only imported when `default_user_turn_stop_strategies()` is called. This improves startup time and removes the `transformers` "PyTorch/TensorFlow/Flax not found" warning when the default stop strategies are not used.

changelog/4395.changed.md

@@ -1 +0,0 @@
-- Broadened `tool_resources` to `app_resources` for easy access not just in tool handlers but in other places like custom `FrameProcessor`s. Three changes: a rename (`tool_resources` → `app_resources`), a new `app_resources` property on `PipelineTask`, and a new `pipeline_task` property on `FrameProcessor`. Tool handlers now read `params.app_resources`; custom processors read `self.pipeline_task.app_resources`. The previous `tool_resources` aliases (on `PipelineTask`, `FunctionCallParams`, and `FrameProcessorSetup`) keep working but are deprecated as of 1.2.0 and emit `DeprecationWarning`s.

changelog/4397.changed.md

@@ -1 +0,0 @@
-- Lowered the per-message log in `SmallWebRTCInputTransport._handle_app_message` from `debug` to `trace`. App messages can be high-frequency and were noisy at debug level; set the loguru level to `TRACE` to see them again.

changelog/4400.added.md

@@ -1 +0,0 @@
-- Added a `mip_opt_out` constructor argument to `DeepgramTTSService` and `DeepgramHttpTTSService` so callers can opt out of the Deepgram Model Improvement Program. When set, the value is forwarded to Deepgram as a query parameter on the speak request. Defaults to `None`, which preserves the existing behavior. See https://dpgr.am/deepgram-mip for pricing implications before enabling.

changelog/4401.changed.md

@@ -1 +0,0 @@
-- Changed the default model for `GrokRealtimeLLMService` to `grok-voice-think-fast-1.0`, xAI's recommended Voice Agent model. The previous default of `grok-voice-fast-1.0` has been deprecated by xAI and is being removed.

changelog/4401.fixed.md

@@ -1 +0,0 @@
-- Fixed `GrokRealtimeLLMService` ignoring the configured model. The model was stored in `Settings` but never sent to xAI, so every session silently fell back to xAI's server-side default. The model is now passed via the `?model=` query parameter on the WebSocket URL as xAI's Voice Agent API requires.

changelog/4404.added.md

@@ -1 +0,0 @@
-- Added an opt-in `add_tool_change_messages` flag to the LLM aggregators (set via `LLMContextAggregatorPair(..., add_tool_change_messages=True)`) that appends a developer-role message to the context whenever `LLMSetToolsFrame` changes the set of advertised standard tools. Helps the LLM stay coherent across mid-conversation tool changes, mitigating several flavors of tool-call-related hallucination: calling tools that have been removed, avoiding tools that have been re-added, and hallucinating output (made-up answers or tool-call-shaped non-tool-calls) when tools are unavailable.

changelog/4405.added.2.md

@@ -1 +0,0 @@
-- Added `LLMTurnCompletionUserTurnStopStrategy` in `pipecat.turns.user_stop`. When installed, the strategy gates `on_user_turn_stopped` on a `UserTurnInferenceCompletedFrame` (a new fieldless system frame emitted by any component that can judge turn completeness — e.g. the `UserTurnCompletionLLMServiceMixin` on `✓`). A `finalization_timeout` provides a safety net if no completion frame ever arrives.

changelog/4405.added.3.md

@@ -1 +0,0 @@
-- Added `deferred(strategy)` and `DeferredUserTurnStopStrategy` in `pipecat.turns.user_stop`. Wraps a stop strategy so it fires only the inference-triggered event and suppresses `on_user_turn_stopped`, leaving finalization to another strategy in the chain such as `LLMTurnCompletionUserTurnStopStrategy`.

changelog/4405.added.4.md

@@ -1 +0,0 @@
-- Added `FilterIncompleteUserTurnStrategies` in `pipecat.turns.user_turn_strategies` — a `UserTurnStrategies` specialization that wraps the detector chain with `deferred(...)` and appends `LLMTurnCompletionUserTurnStopStrategy` as the finalizer. Common case: `user_turn_strategies=FilterIncompleteUserTurnStrategies()`. Pass `config=UserTurnCompletionConfig(...)` to customize timeouts and prompts.

changelog/4405.added.5.md

@@ -1 +0,0 @@
-- Added `ExternalUserTurnCompletionStopStrategy` in `pipecat.turns.user_stop` — a generic stop strategy that finalizes the user turn whenever a `UserTurnInferenceCompletedFrame` arrives, regardless of which component produced it. `LLMTurnCompletionUserTurnStopStrategy` now extends this base; future producers (Flux, custom end-of-turn classifiers, etc.) can use the base directly or subclass it to add producer-specific setup.

changelog/4405.added.md

@@ -1 +0,0 @@
-- Added `on_user_turn_inference_triggered`, a new event on the user turn controller, processor, aggregator and stop strategies that fires when a strategy has enough signal to start LLM inference. By default it fires together with `on_user_turn_stopped`; a gating strategy can fire only the inference-triggered event and defer finalization to a peer.

changelog/4405.deprecated.md

@@ -1 +0,0 @@
-- Deprecated `LLMUserAggregatorParams.filter_incomplete_user_turns`. Use `user_turn_strategies=FilterIncompleteUserTurnStrategies()` (or add `LLMTurnCompletionUserTurnStopStrategy` to a custom `user_turn_strategies.stop`) instead. Setting the legacy flag still works for one release: the aggregator emits a `DeprecationWarning` and rewires the strategies as if you had passed `FilterIncompleteUserTurnStrategies` directly.

changelog/4405.fixed.md

@@ -1 +0,0 @@
-- Fixed `on_user_turn_stopped` firing prematurely when `filter_incomplete_user_turns` was enabled. The event now fires only after the LLM confirms the user turn is complete (`✓`); previously the smart-turn detector's tentative stop was bubbling up before the LLM had a chance to veto it, causing observers, transcript appenders and UI indicators to receive an early — and sometimes duplicated — signal.

changelog/4407.added.md

@@ -1,6 +0,0 @@
-- Added first-class RTVI support for the UI Agent Protocol:
-  - Adds `ui-event`, `ui-snapshot`, and `ui-cancel-task` client-to-server messages, plus `ui-command` and `ui-task` server-to-client messages, with paired `*Data` / `*Message` pydantic models.
-  - Adds built-in command payload models for `Toast`, `Navigate`, `ScrollTo`, `Highlight`, `Focus`, `Click`, `SetInputValue`, and `SelectText`; matching default handlers live in `@pipecat-ai/client-react`.
-  - Adds `RTVIProcessor.on_ui_message` for inbound `ui-event`, `ui-snapshot`, and `ui-cancel-task` messages.
-  - Adds five UI pipeline frames, mirroring the `client-message` frame-and-event pattern: downstream code pushes `RTVIUICommandFrame` / `RTVIUITaskFrame` for the observer to wrap into outbound `UICommandMessage` / `UITaskMessage` envelopes, while the processor pushes inbound `RTVIUIEventFrame`, `RTVIUISnapshotFrame`, and `RTVIUICancelTaskFrame` alongside `on_ui_message`.
-  - Bumps the RTVI `PROTOCOL_VERSION` from `1.2.0` to `1.3.0`.

changelog/4414.fixed.md

@@ -1 +0,0 @@
-- Fixed `TTSSpeakFrame(append_to_context=True)` greetings sometimes splitting across two assistant messages in the LLM context and not surfacing in `on_assistant_turn_stopped`. The `LLMAssistantPushAggregationFrame` emitted at the end of a TTS context now carries a PTS just past the last word so it can't overtake clock-queued `TTSTextFrame`s in the transport's output, and `LLMAssistantAggregator` now triggers `on_assistant_turn_started`/`on_assistant_turn_stopped` when it receives the frame outside an LLM response cycle (restoring v0.0.104 behavior for greeting transcripts).

changelog/4415.fixed.md

@@ -1 +0,0 @@
-- Fixed `ElevenLabsTTSService` and `ElevenLabsHttpTTSService` producing merged words (e.g. `bookLook`) when using Flash models. Flash often splits sentences mid-stream into alignment chunks that begin with a real inter-word space, but the previous fix unconditionally stripped that space from every chunk. Leading spaces are now stripped only on the first alignment chunk of an utterance, so subsequent chunks correctly flush partial words across boundaries.

changelog/4416.added.md

@@ -1 +0,0 @@
-- AWS Transcribe STT, Polly TTS, Bedrock LLM, and the Bedrock AgentCore processor now resolve credentials via the standard boto3 provider chain (EC2 instance profiles, EKS pod roles / IRSA, ECS task roles, SSO, `~/.aws/credentials`) when explicit credentials and `AWS_*` environment variables are absent. Services running with IAM roles no longer need to export static credentials.

changelog/4416.fixed.md

@@ -1 +0,0 @@
-- Fixed AWS Polly TTS, Bedrock LLM, and the Bedrock AgentCore processor erroring out when only one of `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY` was set in the environment. The half-populated kwargs are no longer forwarded to aioboto3; partial env-var configurations now fall through to the boto3 credential chain like fully-unset configurations do.

changelog/4417.security.md

@@ -1 +0,0 @@
-- Fixed a path traversal issue in the development runner's `/files/{filename:path}` download endpoint. Previously, when the runner was started with `--folder`, a request like `/files/..%2F..%2Fetc%2Fpasswd` could escape the configured folder because `%2F`-encoded separators bypassed Starlette's path normalisation. The endpoint now resolves the joined path and rejects any filename that escapes the allowed base with a 403, and also returns 404 (instead of an implicit `null` 200) when `--folder` is unset.

changelog/4422.changed.md

@@ -1 +0,0 @@
-- Changed the default Inworld TTS model from `inworld-tts-1.5-max` to `inworld-tts-2` (Realtime TTS-2) across `InworldHttpTTSService`, `InworldTTSService`, and the `InworldRealtimeLLMService` cascade. Existing users can pin the prior model explicitly via the `model`/`tts_model` argument; both `inworld-tts-1.5-max` and `inworld-tts-1.5-mini` remain valid model IDs.

changelog/4424.fixed.md

@@ -1 +0,0 @@
-- Fixed `ElevenLabsTTSService` and `ElevenLabsHttpTTSService` writing romanized/normalized text to the LLM context. With non-Latin input (e.g., Chinese), the assistant transcript was getting populated with pinyin (`Ni Hao !` instead of `你好！`), which then degraded subsequent LLM turns. The services now consume `alignment` by default and only switch to `normalizedAlignment` / `normalized_alignment` when `pronunciation_dictionary_locators` is configured (where `alignment` has overlapping restarts that produce duplicated/garbled words, per #4316). Both fields are read with preferred-with-fallback semantics since each is nullable per the API schema.

changelog/4426.added.md

@@ -1 +0,0 @@
-- Added `keyterms` support to ElevenLabs STT services so Scribe V2 callers can bias transcription for both file-based and realtime transcription.

changelog/4428.deprecated.md

@@ -1 +0,0 @@
-- Deprecated `ResampyResampler` in favor of `SOXRAudioResampler` (or the `create_file_resampler()` / `create_stream_resampler()` factories). Instantiating `ResampyResampler` now emits a `DeprecationWarning`. The class will be removed in Pipecat 2.0 along with the default `resampy` and `numba` dependencies.

changelog/4429.changed.md

@@ -1 +0,0 @@
-- Changed the default model for `GrokLLMService` from `grok-3` to `grok-4.20-non-reasoning`. xAI is retiring `grok-3` on May 15, 2026.

changelog/4430.added.md

@@ -1 +0,0 @@
-- Added `watchdog_min_timeout` parameter to `DeepgramFluxSTT` and `DeepgramFluxSageMakerSTT` (default `0.5` seconds) to control the minimum silence duration before the watchdog sends a silence packet to prevent dangling turns. The actual threshold is `max(chunk_duration * 2, watchdog_min_timeout)`, so it also adapts automatically to the audio chunk size in use.

changelog/4430.changed.md

@@ -1 +0,0 @@
-- `DeepgramFluxSTT` watchdog silence threshold is now dynamic: `max(chunk_duration * 2, watchdog_min_timeout)` instead of a fixed 500 ms. This prevents false silence injections when large audio chunks are sent at lower frequency.

changelog/4431.fixed.md

@@ -1 +0,0 @@
-- Fixed a deadlock in `TTSService` that could permanently stall pipeline processing when all three conditions occurred together: `pause_frame_processing=True`, an interruption arrived before any TTS audio was played, and an `UninterruptibleFrame` (e.g. `TTSUpdateSettingsFrame`, `FunctionCallResultFrame`) was in the processing queue at that moment. The process task would block on `__process_event.wait()` indefinitely because `BotStoppedSpeakingFrame` never arrives (no audio was played) and the interruption handler did not resume processing. Affects services using `pause_frame_processing=True` such as ElevenLabs, Rime, AsyncAI, Gradium, and ResembleAI.

changelog/4433.changed.md

@@ -1 +0,0 @@
-- `ElevenLabsTTSService` now sends `close_context` to the server as soon as the turn is complete (on `on_turn_context_completed`) rather than waiting until all audio has finished playing back. The `isFinal` message from ElevenLabs is now used to signal `TTSStoppedFrame` and clean up the audio context, improving turn transition timing.

changelog/4434.fixed.md

@@ -1 +0,0 @@
-- Fixed interruptions being delayed when a slow non-uninterruptible frame was processing and an uninterruptible frame was waiting in the queue. The bot would stall until the slow frame finished instead of cancelling it immediately on interruption.

changelog/4435.fixed.md

@@ -1 +0,0 @@
-- Fixed `TTSService` dropping uninterruptible frames (e.g. `FunctionCallResultFrame`) from its internal serialization queue when an interruption occurs. Previously, the queue was recreated on every interruption, silently discarding any queued frames. The queue is now reset instead of recreated, preserving uninterruptible frames so they are always delivered downstream.

changelog/4440.fixed.md

@@ -1 +0,0 @@
-- Fixed a race condition in the Daily transport that caused `AttributeError: 'NoneType' object has no attribute 'send_app_message'` when tearing down a pipeline. Both `DailyInputTransport` and `DailyOutputTransport` share the same `DailyTransportClient` and both call `cleanup()`, which was releasing the underlying `CallClient` on the first call — leaving the second caller with a `None` client.

changelog/4441.fixed.md

@@ -1 +0,0 @@
-- Restored `cancel_on_interruption=False` support for `AWSNovaSonicLLMService` and `OpenAIRealtimeLLMService`. These services previously honored the flag by simply not cancelling in-flight function calls on interruption; the introduction of the new async-tool mechanism (which threads started/intermediate/final messages through the LLM context) broke that path because the realtime services didn't know how to interpret those messages. Note that new-style streamed intermediate results (`FunctionCallResultProperties(is_final=False)`) are not supported on these realtime services. Similar fixes for other impacted realtime services are forthcoming.

changelog/4443.fixed.md

@@ -1 +0,0 @@
-- Fixed two misspelled Gemini TTS voice names in `GeminiTTSService.AVAILABLE_VOICES`.

changelog/4446.change.md

@@ -1 +0,0 @@
-- Updated `InworldHttpTTSService` and `InworldTTSService` to use PCM audio encoding by default, which returns audio bytes without headers.

changelog/4447.fixed.md

@@ -1 +0,0 @@
-- Extended the `cancel_on_interruption=False` regression fix to `GrokRealtimeLLMService`, `AzureRealtimeLLMService`, and `UltravoxRealtimeLLMService`. Grok and Azure use the same approach as in #4441 (each service detects async-tool messages in the LLM context and routes the final result to its formal tool-result channel; Azure inherits transitively from `OpenAIRealtimeLLMService`). Ultravox needed a different approach because its API freezes the conversation between `client_tool_invocation` and the matching `client_tool_result` — for async-registered functions it now ships a placeholder `client_tool_result` immediately when the function is invoked (to unfreeze the conversation), then injects the real result as user-side text once the tool finishes. Streamed intermediate results (`FunctionCallResultProperties(is_final=False)`) are still not supported on any of these realtime services. `GeminiLiveLLMService` and `InworldRealtimeLLMService` are excluded for now: Gemini Live's async-tool path needs deeper investigation, and Inworld appears to have a pre-existing problem with even simple tool calling on its Realtime API.

changelog/4448.added.md

@@ -1 +0,0 @@
-- Added `cancel_on_interruption=False` support for `GeminiLiveLLMService` on models that support Gemini's NON_BLOCKING tool mechanism (currently Gemini 2.x); the conversation now continues while the tool runs. On models that don't yet support NON_BLOCKING (Gemini 3.x), the service surfaces a one-time warning explaining the limitation. (Note: an intermittent 1008 error can occasionally fire on Gemini 2.5 during long-running tool calls; we auto-reconnect.)

changelog/4449.changed.md

@@ -1 +0,0 @@
-- Moved `create_task`, `cancel_task`, the `task_manager` property, and `setup(task_manager)` up from `FrameProcessor` to `BaseObject`. Custom `BaseObject` subclasses (turn strategies, controllers, etc.) now inherit these methods directly instead of reimplementing the task manager wiring. Owners propagate the task manager to their child `BaseObject`s via `await child.setup(task_manager)`.

changelog/4450.changed.md

@@ -1 +0,0 @@
-- Changed the default OpenAI Realtime input audio transcription model from `gpt-4o-transcribe` to `gpt-realtime-whisper` for both `OpenAIRealtimeSTTService` and `OpenAIRealtimeLLMService`. The new model does not accept the `prompt` parameter; if a prompt is supplied alongside `gpt-realtime-whisper`, it is dropped automatically and a warning is logged. To keep using prompt hints, explicitly pin `model="gpt-4o-transcribe"` (or `"gpt-4o-mini-transcribe"`).

changelog/4462.changed.md

@@ -1 +0,0 @@
-- Updated the default model for `CartesiaTTSService` and `CartesiaHttpTTSService` from `sonic-3` to `sonic-3.5`.

changelog/4464.added.2.md

@@ -1 +0,0 @@
-- Added NVIDIA Magpie TTS services via AWS SageMaker: `NvidiaSageMakerHTTPTTSService` (single HTTP invocation, streams raw PCM back) and `NvidiaSageMakerWebsocketTTSService` (persistent HTTP/2 bidi-stream with full interruption support via `InterruptibleTTSService`).

changelog/4464.added.md

@@ -1 +0,0 @@
-- Added `NvidiaSageMakerWebsocketSTTService` for streaming speech recognition using NVIDIA Nemotron ASR via an AWS SageMaker bidirectional-stream endpoint. Produces `InterimTranscriptionFrame` and `TranscriptionFrame` frames, is VAD-aware, and automatically reconnects on error.

changelog/4465.fixed.md

@@ -1 +0,0 @@
-- Fixed `OpenAIRealtimeLLMService` handling of multi-output-item responses (observed with `gpt-realtime-2`). A single response can now contain more than one audio item, and the first item's `audio.done` may arrive after the second item's deltas have started. Deltas still arrive strictly in playback order, so we continue to forward them as received (matching OpenAI's reference implementation). The fix removes spurious warnings, ensures truncation always targets the latest audio item, and emits a single bracketing `TTSStartedFrame`/`TTSStoppedFrame` pair per assistant turn (the Stopped is now pushed on `response.done`).

changelog/4470.added.md

@@ -1 +0,0 @@
-- Added support for `reasoning` configuration on `OpenAIRealtimeLLMService`, for use with reasoning-capable Realtime models such as `gpt-realtime-2`.

changelog/4472.changed.md

@@ -1 +0,0 @@
-- Changed the default model for `OpenAIRealtimeLLMService` from `gpt-realtime-1.5` to `gpt-realtime-2`.

changelog/4480.added.md

@@ -1 +0,0 @@
-- Added `wait_for_transcript_to_end_user_turn` on `LLMUserAggregatorParams` for pipelines where local turn detection drives a realtime service like Gemini Live. Set it to False to avoid unnecessary latency from transcript delay — the realtime service consumes user audio directly, so we don't need user transcripts in context before it can respond. The option makes it so that (1) turn strategies do not consider user transcripts, letting the user turn end sooner, and (2) user transcripts are then handled by the aggregator: a simple timer gives it time to gather those transcripts after the user turn ends, and once gathered, the aggregator emits a new `on_user_turn_message_finalized` event with the new user context message. The new event also fires in the default mode (coinciding with `on_user_turn_stopped`), so consumers that want the populated user transcript can subscribe to it uniformly. See `examples/realtime/realtime-gemini-live-local-vad.py` for the full pattern.

changelog/_template.md.j2

@@ -1,16 +0,0 @@
-{% for section, _ in sections.items() %}
-{% if sections[section] %}
-{% for category, val in definitions.items() if category in sections[section]%}
-### {{ definitions[category]['name'] }}
-
-{% for text, values in sections[section][category].items() %}
-{{ text }}
-  (PR {{ values|join(', ') }})
-
-{% endfor %}
-{% endfor %}
-{% else %}
-No significant changes.
-
-{% endif %}
-{% endfor %}

dev-requirements.txt

@@ -0,0 +1,13 @@
+build~=1.2.2
+coverage~=7.6.12
+grpcio-tools~=1.67.1
+pip-tools~=7.4.1
+pre-commit~=4.0.1
+pyright~=1.1.397
+pytest~=8.3.4
+pytest-asyncio~=0.25.3
+pytest-aiohttp==1.1.0
+ruff~=0.11.1
+setuptools~=70.0.0
+setuptools_scm~=8.1.0
+python-dotenv~=1.0.1

docs/README.md

@@ -0,0 +1,10 @@
+# Pipecat Docs
+
+## [Architecture Overview](architecture.md)
+
+Learn about the thinking behind the framework's design.
+
+## [A Frame's Progress](frame-progress.md)
+
+See how a Frame is processed through a Transport, a Pipeline, and a series of Frame Processors.
+

docs/api/README.md

@@ -1,60 +1,109 @@
-# Pipecat API Documentation
+# Pipecat Documentation
 
-This directory contains the source files for auto-generating Pipecat's API reference documentation.
+This directory contains the source files for auto-generating Pipecat's server API reference documentation.
+
+## Setup
+
+1. Install documentation dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+2. Make the build scripts executable:
+
+```bash
+chmod +x build-docs.sh rtd-test.py
+```
 
 ## Building Documentation
 
-From this directory:
+From this directory, you can build the documentation in several ways:
+
+### Local Build
 
 ```bash
-# Build docs (warnings shown but don't fail the build)
-cd docs/api && uv run ./build-docs.sh
+# Using the build script (automatically opens docs when done)
+./build-docs.sh
 
-# Build with strict mode (warnings treated as errors)
-cd docs/api && uv run ./build-docs.sh --strict
+# Or directly with sphinx-build
+sphinx-build -b html . _build/html -W --keep-going
 ```
 
-The build script will:
+### ReadTheDocs Test Build
 
-1. Install documentation dependencies via `uv sync --group docs`
-2. Clean previous build output
-3. Run `sphinx-build` to generate HTML documentation
-4. Open the result in your browser (macOS)
+To test the documentation build process exactly as it would run on ReadTheDocs:
+
+```bash
+./rtd-test.py
+```
+
+This script:
+
+- Creates a fresh virtual environment
+- Installs all dependencies as specified in requirements files
+- Handles conflicting dependencies (like grpcio versions for Riva and PlayHT)
+- Builds the documentation in an isolated environment
+- Provides detailed logging of the build process
+
+Use this script to verify your documentation will build correctly on ReadTheDocs before pushing changes.
+
+## Viewing Documentation
+
+The built documentation will be available at `_build/html/index.html`. To open:
+
+```bash
+# On MacOS
+open _build/html/index.html
+
+# On Linux
+xdg-open _build/html/index.html
+
+# On Windows
+start _build/html/index.html
+```
 
 ## Directory Structure
 
 ```
 .
-├── api/            # Auto-generated API documentation (created during build)
-├── _build/         # Built documentation output
-├── conf.py         # Sphinx configuration (mock imports, extensions, etc.)
+├── api/            # Auto-generated API documentation
+├── _build/         # Built documentation
+├── _static/        # Static files (images, css, etc.)
+├── conf.py         # Sphinx configuration
 ├── index.rst       # Main documentation entry point
+├── requirements-base.txt    # Base documentation dependencies
+├── requirements-riva.txt    # Riva-specific dependencies
+├── requirements-playht.txt  # PlayHT-specific dependencies
 ├── build-docs.sh   # Local build script
-└── rtd-test.sh     # ReadTheDocs test build script (uses pip, not uv)
+└── rtd-test.py     # ReadTheDocs test build script
 ```
 
-## How It Works
+## Notes
 
-- `conf.py` runs `sphinx-apidoc` during Sphinx's `setup()` phase to generate `.rst` files from Python source
-- Sphinx autodoc imports each module to extract docstrings
-- Modules with unavailable dependencies are listed in `autodoc_mock_imports` in `conf.py`
-- Napoleon extension converts Google-style docstrings to reStructuredText
+- Documentation is auto-generated from Python docstrings
+- Service modules are automatically detected and included
+- The build process matches our ReadTheDocs configuration
+- Warnings are treated as errors (-W flag) to maintain consistency
+- The --keep-going flag ensures all errors are reported
+- Dependencies are split into multiple requirements files to handle version conflicts
 
 ## Troubleshooting
 
-**Module not appearing in docs:**
+If you encounter missing service modules:
 
-1. Check the build output for `autodoc: failed to import` warnings
-2. If the module has an unresolvable import dependency, add it to `autodoc_mock_imports` in `conf.py`
-3. Verify the module is importable: `uv run python -c "import pipecat.module.name"`
+1. Verify the service is installed with its extras: `pip install pipecat-ai[service-name]`
+2. Check the build logs for import errors
+3. Ensure the service module is properly initialized in the package
+4. Run `./rtd-test.py` to test in an isolated environment matching ReadTheDocs
 
-**Duplicate object warnings:**
+For dependency conflicts:
 
-These come from re-export modules or Sphinx discovering the same class through multiple import paths. Usually cosmetic.
+1. Check the requirements files for version specifications
+2. Use `rtd-test.py` to verify dependency resolution
+3. Consider adding service-specific requirements files if needed
 
-**Docstring formatting warnings:**
+For more information:
 
-Docstrings use reStructuredText, not Markdown. Common issues:
-- Use `Example::` with indented code blocks, not `` ```python ``
-- Ensure blank lines between directive content and subsequent sections
-- Use `Parameters:` (not `Attributes:`) for dataclass field documentation to avoid duplicate entries
+- [ReadTheDocs Configuration](.readthedocs.yaml)
+- [Sphinx Documentation](https://www.sphinx-doc.org/)