wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #4194 from pipecat-ai/mb/update-community-integrations-package-convention

Browse Source 
Add pipecat-{vendor} package naming convention to community guide
This commit is contained in:
Mark Backman
2026-03-30 08:52:28 -04:00
committed by GitHub
parent dd3ca6fbba 171692aa30
commit 2e0f5fc6e9
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
COMMUNITY_INTEGRATIONS.md
View File

@@ -225,6 +225,17 @@ Vision services process images and provide analysis such as descriptions, object
### Naming Conventions ### 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` - **STT:** `VendorSTTService`
- **LLM:** `VendorLLMService` - **LLM:** `VendorLLMService`
- **TTS:** - **TTS:**
@@ -406,8 +417,9 @@ Use Pipecat's tracing decorators:
### Packaging and Distribution ### Packaging and Distribution
- Name your package `pipecat-{vendor}` (see [Naming Conventions](#naming-conventions))
- Use [uv](https://docs.astral.sh/uv/) for packaging (encouraged) - Use [uv](https://docs.astral.sh/uv/) for packaging (encouraged)
- Consider releasing to PyPI for easier installation - Publish to PyPI for easier installation
- Follow semantic versioning principles - Follow semantic versioning principles
- Maintain a changelog - Maintain a changelog