pyproject.toml

[build-system]
requires = ["setuptools>=64", "setuptools_scm>=8"]
build-backend = "setuptools.build_meta"

[project]
name = "pipecat-ai"
dynamic = ["version"]
description = "An open source framework for voice (and multimodal) assistants"
license = "BSD-2-Clause"
license-files = ["LICENSE"]
readme = "README.md"
requires-python = ">=3.11"
keywords = ["webrtc", "audio", "video", "ai"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Topic :: Communications :: Conferencing",
    "Topic :: Multimedia :: Sound/Audio",
    "Topic :: Multimedia :: Video",
    "Topic :: Scientific/Engineering :: Artificial Intelligence"
]
dependencies = [
    "aiofiles>=24.1.0,<27",
    "aiohttp>=3.11.12,<4",
    "audioop-lts~=0.2.1; python_version>='3.13'",
    "docstring_parser>=0.16,<1",
    "loguru~=0.7.3",
    "loudness>=0.2.0,<1",
    "Markdown>=3.7,<4",
    "nltk>=3.10.0,<4",
    "numpy>=1.26.4,<3",
    "Pillow>=11.1.0,<13",
    "protobuf>=5.29.6,<7",
    "pydantic>=2.10.6,<3",
    # pydantic <2.13 has no cp314 wheels; pin a floor so 3.14 resolves
    "pydantic>=2.13; python_full_version >= '3.14'",
    "python-dotenv>=1.0.0,<2.0.0",
    "resampy~=0.4.3",
    "soundfile~=0.13.1",
    "soxr~=1.0.0",
    "openai>=1.74.0,<4",
    "typing_extensions>=4.9",
    # Pinning numba to resolve package dependencies
    "numba>=0.61.2,<1",
    "wait_for2>=0.4.1,<1; python_version<'3.12'",
    "websockets>=13.1",
    "pyyaml>=6,<7",
    "num2words>=0.5.14",
    # Required by LocalSmartTurnAnalyzerV3
    # Inlined here instead of using a self-referential extra for Poetry compatibility.
    "onnxruntime~=1.24.3",
]

[project.urls]
Homepage = "https://pipecat.ai"
Documentation = "https://docs.pipecat.ai/"
Source = "https://github.com/pipecat-ai/pipecat"
Issues = "https://github.com/pipecat-ai/pipecat/issues"
Changelog = "https://github.com/pipecat-ai/pipecat/blob/main/CHANGELOG.md"

[project.scripts]
# The Pipecat CLI ships with pipecat-ai, but its dependencies are optional (the `cli`
# extra). These console scripts target a graceful-degradation shim that prints an
# install hint when the `cli` extra isn't installed (rather than an ImportError).
pipecat = "pipecat.cli.main:run"
pc = "pipecat.cli.main:run"

[project.optional-dependencies]
aic = [ "aic-sdk~=3.1.0" ]
anthropic = [ "anthropic>=0.49.0,<2" ]
assemblyai = []
asyncai = []
aws = [ "aiobotocore>=3,<4" ]
aws-nova-sonic = [ "aws_sdk_bedrock_runtime~=0.4.0; python_version>='3.12'" ]
azure = [ "azure-cognitiveservices-speech>=1.47.0,<2"]
baseten = []
bland = []
cartesia = []
camb = [ "camb-sdk>=1.5.4,<2" ]
cerebras = []
crusoe = []
daily = [ "daily-python>=0.29.0,<1" ]
deepgram = [ "deepgram-sdk>=6.1.1,<8" ]
deepseek = []
elevenlabs = []
evals = [ "pipecat-ai[cli]", "pipecat-ai[kokoro]", "pipecat-ai[moonshine]" ]
fal = []
fireworks = []
fish = [ "ormsgpack>=1.7.0,<2" ]
funasr = [ "funasr>=1.1.0" ]
gladia = []
google = [ "google-cloud-speech>=2.33.0,<3", "google-cloud-texttospeech>=2.31.0,<3", "google-genai>=1.68.0,<3" ]
gradium = []
grok = []
groq = [ "groq>=0.23.0,<2" ]
gstreamer = [ "pygobject~=3.50.0" ]
heygen = [ "livekit>=1.0.13,<2" ]
hume = [ "hume>=0.11.2,<1" ]
inception = []
inworld = []
keenable = [ "pipecat-ai[mcp]" ]
koala = [ "pvkoala~=2.0.3" ]
kokoro = [ "kokoro-onnx>=0.5.0,<1", "requests>=2.32.5,<3" ]
langchain = [ "langchain>=1.2.13,<2", "langchain-community>=0.4.1,<1", "langchain-openai>=1.1.12,<2" ]
lemonslice = [ "pipecat-ai[daily]" ]
livekit = [ "livekit>=1.0.13,<2", "livekit-api>=1.0.5,<2", "tenacity>=8.2.3,<10.0.0", "pyjwt>=2.12.0,<3" ]
local = [ "pyaudio~=0.2.14" ]
local-smart-turn = [ "coremltools>=8.0", "transformers>=4.48.0,<6", "torch>=2.5.0,<3", "torchaudio>=2.5.0,<3" ]
mcp = [ "mcp[cli]>=1.24.0,<3" ]
mem0 = [ "mem0ai>=2,<3" ]
meta = []
mistral = ["mistralai>=2.0.0,<3"]
mlx-whisper = [ "mlx-whisper~=0.4.2" ]
moondream = [ "accelerate~=1.10.0", "einops~=0.8.0", "pyvips[binary]~=3.0.0", "timm~=1.0.13", "transformers>=4.48.0,<6" ]
moonshine = [ "moonshine-voice>=0.1.5" ]
moq = [ "moq-rs~=0.4.4", "cryptography>=45.0.0" ]
nebius = []
neuphonic = []
novita = []
nvidia = [ "nvidia-riva-client>=2.25.1,<3", "protobuf>=6.31.1,<7" ]
openai = []
rnnoise = [ "pyrnnoise~=0.4.3", "av<17.1.0" ]
openrouter = []
perplexity = []
pgmq = ["pgmq>=1.0.6,<1.1", "asyncpg>=0.30.0"]
piper = [ "piper-tts>=1.3.0,<2", "requests>=2.32.5,<3" ]
pocket-tts = [ "pocket-tts>=2.1.0,<3" ]
qwen = []
redis = ["redis[hiredis]>=5.0.0"]
resembleai = []
rime = []
runner = [ "uvicorn>=0.32.0,<1.0.0", "fastapi>=0.115.6,<1", "pipecat-ai-prebuilt>=1.1.0"]
sagemaker = ["aws_sdk_sagemaker_runtime_http2; python_version>='3.12'"]
sambanova = []
sarvam = [ "sarvamai==0.1.28" ]
sentry = [ "sentry-sdk>=2.28.0,<3" ]
silero = []
simli = [ "simli-ai~=2.0.1"]
smallest = []
soniox = []
soundfile = []
speechify = []
speechmatics = ["speechmatics-agent-stt~=0.1.0"]
strands = [ "strands-agents>=1.9.1,<2" ]
tavus = [ "pipecat-ai[daily]" ]
together = []
tracing = [ "opentelemetry-sdk>=1.33.0,<2", "opentelemetry-api>=1.33.0,<2", "opentelemetry-instrumentation>=0.54b0,<1" ]
ultravox = []
vonage-video-connector = [ "vonage-video-connector~=1.0.2; python_version=='3.13' and platform_system=='Linux'" ]
webrtc = [ "aiortc>=1.14.0,<2", "opencv-python-headless>=4.11.0.86,<5" ]
webrtc-video = [ "pipecat-ai[webrtc]" ]
websocket = [ "fastapi>=0.115.6,<1" ]
whisper = [ "faster-whisper~=1.2.1" ]
xai = []

# CLI tooling for `pipecat init` (not a service). Optional so the runtime/base-image
# install stays lean; install with `pip install "pipecat-ai[cli]"`.
cli = [
    "typer>=0.20.0,<1",
    "rich>=13.0.0,<14",
    "jinja2>=3.1.0,<4",
    "questionary>=2.0.0,<3",
    "ruff>=0.12.1,<1",
    "pipecat-ai-context-hub>=0.7.0,<1",
]

[dependency-groups]
dev = [
    "build~=1.4.0",
    "coverage~=7.13.4",
    "grpcio-tools>=1.67.1,<2",
    "pip-tools~=7.5.3",
    "pre-commit~=4.5.1",
    "pyright==1.1.411",
    "pytest>=9.0.0,<10",
    "pytest-asyncio>=1.0.0,<2",
    "pytest-aiohttp>=1.0.0,<2",
    "ruff>=0.12.11,<1",
    "setuptools~=83.0.0",
    "setuptools_scm~=8.3.1",
    "towncrier~=25.8.0",
]

docs = [
    "sphinx>=8.1.3",
    "sphinx-rtd-theme",
]

[tool.uv]
# The Vonage-Google package conflict — vonage-video-connector pins pydantic < 2.12,
# while google-genai >= 2.9.0 (which GeminiSTTService needs) requires pydantic >= 2.12.5
# — must not prevent GeminiSTTService usage in environments where the Vonage connector
# can't be installed anyway. Resolving the one environment where it can be installed
# (Python 3.13 on Linux) apart from every other keeps the rest of the lock current.
environments = [
    "python_full_version == '3.13.*' and sys_platform == 'linux'",
    "python_full_version != '3.13.*' or sys_platform != 'linux'",
]

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools.package-data]
"pipecat" = ["py.typed"]
"pipecat.audio.dtmf" = [
    "src/pipecat/audio/dtmf/dtmf-0.wav",
    "src/pipecat/audio/dtmf/dtmf-1.wav",
    "src/pipecat/audio/dtmf/dtmf-2.wav",
    "src/pipecat/audio/dtmf/dtmf-3.wav",
    "src/pipecat/audio/dtmf/dtmf-4.wav",
    "src/pipecat/audio/dtmf/dtmf-5.wav",
    "src/pipecat/audio/dtmf/dtmf-6.wav",
    "src/pipecat/audio/dtmf/dtmf-7.wav",
    "src/pipecat/audio/dtmf/dtmf-8.wav",
    "src/pipecat/audio/dtmf/dtmf-9.wav",
    "src/pipecat/audio/dtmf/dtmf-pound.wav",
    "src/pipecat/audio/dtmf/dtmf-star.wav",
]
"pipecat.services.aws_nova_sonic" = ["src/pipecat/services/aws_nova_sonic/ready.wav"]
"pipecat.audio.turn.smart_turn.data" = ["src/pipecat/audio/turn/smart_turn/data/smart-turn-v3.2-cpu.onnx"]
# CLI project-scaffolding templates (jinja + client TS/JS/JSON/CSS trees). The
# `.gitignore` patterns are listed explicitly because glob `*` does not match dotfiles.
"pipecat.cli" = [
    "templates/**/*",
    "templates/**/.gitignore",
    # Agent-readiness files written by `pipecat init` (AGENTS.md + CLAUDE.md).
    "agent_templates/**/*",
]

[tool.pytest.ini_options]
addopts = "--verbose"
testpaths = ["tests"]
pythonpath = ["src"]
asyncio_default_fixture_loop_scope = "function"
filterwarnings = [
    "ignore:'audioop' is deprecated:DeprecationWarning",
]

[tool.setuptools_scm]
local_scheme = "no-local-version"
fallback_version = "0.0.0-dev"

[tool.ruff]
exclude = [".git", "*_pb2.py"]
line-length = 100

[tool.ruff.lint]
select = [
    "ASYNC", # Blocking calls and other misuse inside async functions
    "B", # Likely bugs and design problems
    "D", # Docstring rules
    "F", # Pyflakes
    "I", # Import rules
    "RUF006", # asyncio tasks nothing holds a reference to
    "UP", # Modern Python
]
ignore = [
    # Async rules that do not fit this codebase.
    #
    # ASYNC109 objects to a `timeout` parameter on an async function, which is
    # how cancellation is spelled throughout pipecat's own API, and ASYNC240
    # prescribes trio.Path or anyio.path for filesystem work; pipecat runs on
    # asyncio, and the calls it flags are in CLI and startup paths.
    "ASYNC109",
    "ASYNC240",
    #
    # ASYNC110 is a deferral: its one site polls a queue in the audio output
    # path, and swapping it for an Event means restructuring a real-time loop.
    "ASYNC110",
    #
    # Bugbear rules that do not fit this codebase.
    #
    # Base classes leave optional hooks empty so subclasses override only what
    # they need. Marking them abstract, as B027 wants, would instead force every
    # subclass to implement them, and BaseObject is a shared-behaviour base
    # rather than an interface, so it has no abstract methods to declare.
    "B024",
    "B027",
    #
    # Bugbear rules worth adopting, each on its own once someone takes the
    # sweep. Every entry below is a deferral, not a rejection: drop the line and
    # fix what it reports.
    "B007", # unused loop control variable — 23 sites, cosmetic
    "B904", # `raise ... from` — 48 sites, better tracebacks, no behaviour change
    "B905", # `zip(strict=)` — 18 sites, each needs its own length-invariant call
    #
    "D105",  # Missing docstring in magic methods (__str__, __repr__, etc.)
    # Unused imports are selected in .pre-commit-config.yaml instead, so they are
    # only stripped at commit time, not mid-development. A `--extend-select` on the
    # command line overrides this entry, so the hook still reports and fixes them.
    "F401",
]

[tool.ruff.lint.flake8-bugbear]
# Typer reads a CLI parameter's configuration from its default, so calling these
# in a default argument is the documented idiom rather than a shared-state bug.
extend-immutable-calls = ["typer.Argument", "typer.Option"]

[tool.ruff.lint.per-file-ignores]
# Skip docstring checks for non-source code. ASYNC230 and RUF006 are enforced in
# the framework, where a blocked event loop stalls a live session and a collected
# task drops one, and left off the demo and test code around it: both findings
# there want a per-site rewrite that would bury what the file is teaching.
"examples/**/*.py" = ["D", "ASYNC230", "RUF006"]
"tests/**/*.py" = ["D", "ASYNC230", "RUF006"]
"scripts/**/*.py" = ["D", "ASYNC230", "RUF006"]
"docs/**/*.py" = ["D"]
# Skip D104 (missing docstring in public package) for __init__.py files
"**/__init__.py" = ["D104"]
# Skip specific rules for generated protobuf files
"**/*_pb2.py" = ["D"]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.coverage.run]
command_line = "--module pytest"
source = ["src"]
omit = ["*/tests/*"]

[tool.towncrier]
package = "pipecat"
package_dir = "src"
filename = "CHANGELOG.md"
directory = "changelog"
start_string = "<!-- towncrier release notes start -->\n"
template = "changelog/_template.md.j2"
title_format = "## [{version}] - {project_date}"
issue_format = "[#{issue}](https://github.com/pipecat-ai/pipecat/pull/{issue})"
underlines = ["", "", ""]
wrap = true

[[tool.towncrier.type]]
directory = "added"
name = "Added"
showcontent = true

[[tool.towncrier.type]]
directory = "changed"
name = "Changed"
showcontent = true

[[tool.towncrier.type]]
directory = "deprecated"
name = "Deprecated"
showcontent = true

[[tool.towncrier.type]]
directory = "removed"
name = "Removed"
showcontent = true

[[tool.towncrier.type]]
directory = "fixed"
name = "Fixed"
showcontent = true

[[tool.towncrier.type]]
directory = "performance"
name = "Performance"
showcontent = true

[[tool.towncrier.type]]
directory = "security"
name = "Security"
showcontent = true

[[tool.towncrier.type]]
directory = "other"
name = "Other"
showcontent = true