pipecat-guardrails 0.0.1__tar.gz

pipecat_guardrails-0.0.1/.gitignore

@@ -0,0 +1,24 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+
+# Environments
+.venv/
+.env
+.env.*
+
+# Tools
+.pytest_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db

pipecat_guardrails-0.0.1/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project are documented here.
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.0.1] - 2026-10-31
+
+### Added
+- Package structure, CI and release workflow. No guardrail functionality yet.
+
+[Unreleased]: https://github.com/Apoorv012/pipecat-guardrails/compare/v0.0.1...HEAD
+[0.0.1]: https://github.com/Apoorv012/pipecat-guardrails/releases/tag/v0.0.1

pipecat_guardrails-0.0.1/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2026, Apoorv Mittal
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pipecat_guardrails-0.0.1/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.5
+Name: pipecat-guardrails
+Version: 0.0.1
+Summary: Output guardrails for Pipecat voice agents: check what the bot is about to say, and stop it before it is spoken.
+Project-URL: Homepage, https://github.com/Apoorv012/pipecat-guardrails
+Project-URL: Repository, https://github.com/Apoorv012/pipecat-guardrails
+Project-URL: Issues, https://github.com/Apoorv012/pipecat-guardrails/issues
+Project-URL: Changelog, https://github.com/Apoorv012/pipecat-guardrails/blob/main/CHANGELOG.md
+Author: Apoorv Mittal
+License-Expression: BSD-2-Clause
+License-File: LICENSE
+Keywords: guardrails,llm,moderation,pipecat,safety,tts,voice
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pipecat-ai<2,>=1.12
+Provides-Extra: jev
+Requires-Dist: pipecat-ai[jev]<2,>=1.12; extra == 'jev'
+Description-Content-Type: text/markdown
+
+# pipecat-guardrails
+
+Output guardrails for [Pipecat](https://github.com/pipecat-ai/pipecat) voice agents. It checks what
+your bot is about to say, and stops it before it is spoken.
+
+> **Status: early development.** Version 0.0.1 contains the package structure only, with no
+> guardrails yet. Follow the repo for the first usable release (0.1.0).
+
+## The problem
+
+Pipecat has no built-in output guardrail, so every team writes its own processor between the LLM
+and the TTS. These homemade processors tend to break on user interruptions, keep speaking after a
+violation, let blocked text into the LLM history, and miss paraphrases and Hindi/Hinglish text.
+
+This package will provide one processor you add to your pipeline:
+
+```python
+pipeline = Pipeline([
+    transport.input(), stt, context_aggregator.user(), llm,
+    OutputGuardProcessor(guard),   # checks each sentence before it is spoken
+    tts, transport.output(), context_aggregator.assistant(),
+])
+```
+
+There will also be a plain `await guard.check(text)` for apps that run their own LLM loop.
+
+See [BEFORE_AFTER.md](https://github.com/Apoorv012/pipecat-guardrails/blob/main/BEFORE_AFTER.md)
+for a side-by-side comparison and
+[PLAN.md](https://github.com/Apoorv012/pipecat-guardrails/blob/main/PLAN.md) for the design and
+roadmap.
+
+## Install
+
+```bash
+pip install pipecat-guardrails          # includes Pipecat
+pip install "pipecat-guardrails[jev]"   # also installs the TypeSafe Jev classifier client
+```
+
+Requires Python 3.11+ and Pipecat 1.12 or later (installed automatically).
+
+## How checking works
+
+Each sentence goes through up to three layers, and stops at the first one that is sure:
+
+1. **Banned words, PII, regex**: local and instant.
+2. **Classifier model** (optional), such as TypeSafe Jev: a fast yes/no model with an API key.
+   A confident answer decides; an unsure one moves to layer 3.
+3. **LLM judge** (optional): any OpenAI-compatible LLM gives the final answer.
+
+Layers 2 and 3 use Pipecat's own classifiers (`pipecat.classifiers`), so any classifier Pipecat
+supports works here.
+
+## Development
+
+```bash
+uv sync                      # create .venv with dev tools
+uv run pytest                # tests
+uv run ruff check .          # lint
+uv run ruff format .         # format
+uv run pyright               # type check
+uv run pre-commit install    # run the checks on every commit
+```
+
+## License
+
+BSD-2-Clause, the same as Pipecat.

pipecat_guardrails-0.0.1/README.md

@@ -0,0 +1,66 @@
+# pipecat-guardrails
+
+Output guardrails for [Pipecat](https://github.com/pipecat-ai/pipecat) voice agents. It checks what
+your bot is about to say, and stops it before it is spoken.
+
+> **Status: early development.** Version 0.0.1 contains the package structure only, with no
+> guardrails yet. Follow the repo for the first usable release (0.1.0).
+
+## The problem
+
+Pipecat has no built-in output guardrail, so every team writes its own processor between the LLM
+and the TTS. These homemade processors tend to break on user interruptions, keep speaking after a
+violation, let blocked text into the LLM history, and miss paraphrases and Hindi/Hinglish text.
+
+This package will provide one processor you add to your pipeline:
+
+```python
+pipeline = Pipeline([
+    transport.input(), stt, context_aggregator.user(), llm,
+    OutputGuardProcessor(guard),   # checks each sentence before it is spoken
+    tts, transport.output(), context_aggregator.assistant(),
+])
+```
+
+There will also be a plain `await guard.check(text)` for apps that run their own LLM loop.
+
+See [BEFORE_AFTER.md](https://github.com/Apoorv012/pipecat-guardrails/blob/main/BEFORE_AFTER.md)
+for a side-by-side comparison and
+[PLAN.md](https://github.com/Apoorv012/pipecat-guardrails/blob/main/PLAN.md) for the design and
+roadmap.
+
+## Install
+
+```bash
+pip install pipecat-guardrails          # includes Pipecat
+pip install "pipecat-guardrails[jev]"   # also installs the TypeSafe Jev classifier client
+```
+
+Requires Python 3.11+ and Pipecat 1.12 or later (installed automatically).
+
+## How checking works
+
+Each sentence goes through up to three layers, and stops at the first one that is sure:
+
+1. **Banned words, PII, regex**: local and instant.
+2. **Classifier model** (optional), such as TypeSafe Jev: a fast yes/no model with an API key.
+   A confident answer decides; an unsure one moves to layer 3.
+3. **LLM judge** (optional): any OpenAI-compatible LLM gives the final answer.
+
+Layers 2 and 3 use Pipecat's own classifiers (`pipecat.classifiers`), so any classifier Pipecat
+supports works here.
+
+## Development
+
+```bash
+uv sync                      # create .venv with dev tools
+uv run pytest                # tests
+uv run ruff check .          # lint
+uv run ruff format .         # format
+uv run pyright               # type check
+uv run pre-commit install    # run the checks on every commit
+```
+
+## License
+
+BSD-2-Clause, the same as Pipecat.

pipecat_guardrails-0.0.1/pyproject.toml

@@ -0,0 +1,89 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pipecat-guardrails"
+version = "0.0.1"
+description = "Output guardrails for Pipecat voice agents: check what the bot is about to say, and stop it before it is spoken."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "BSD-2-Clause"
+license-files = ["LICENSE"]
+authors = [{ name = "Apoorv Mittal" }]
+keywords = ["pipecat", "guardrails", "voice", "llm", "safety", "moderation", "tts"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Sound/Audio :: Speech",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Typing :: Typed",
+]
+# Pipecat supplies the classifier and LLM-judge backends (pipecat.classifiers),
+# the OpenAI SDK, and the frame-processor base class.
+dependencies = ["pipecat-ai>=1.12,<2"]
+
+[project.optional-dependencies]
+jev = ["pipecat-ai[jev]>=1.12,<2"]  # TypeSafe Jev classifier client
+
+[project.urls]
+Homepage = "https://github.com/Apoorv012/pipecat-guardrails"
+Repository = "https://github.com/Apoorv012/pipecat-guardrails"
+Issues = "https://github.com/Apoorv012/pipecat-guardrails/issues"
+Changelog = "https://github.com/Apoorv012/pipecat-guardrails/blob/main/CHANGELOG.md"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pytest-asyncio>=0.24",
+    "pytest-cov>=5",
+    "ruff>=0.8",
+    "pyright>=1.1.390",
+    "pre-commit>=4",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pipecat_guardrails"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/", "tests/", "README.md", "CHANGELOG.md", "LICENSE"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+extend-exclude = ["*.md"]  # code samples in docs are formatted by hand
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "RUF", "D"]
+ignore = ["D105", "D107"]  # magic methods and __init__ are documented on the class
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D"]
+
+[tool.pyright]
+include = ["src", "tests"]
+pythonVersion = "3.11"
+typeCheckingMode = "strict"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+addopts = ["--strict-markers", "--strict-config"]
+
+[tool.coverage.run]
+source = ["pipecat_guardrails"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+skip_covered = true

pipecat_guardrails-0.0.1/src/pipecat_guardrails/__init__.py

@@ -0,0 +1,14 @@
+"""Output guardrails for Pipecat voice agents.
+
+Checks what a voice agent is about to say and stops it before it is spoken.
+This package is in early development; see the README for status.
+"""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("pipecat-guardrails")
+except PackageNotFoundError:  # running from a source tree without an install
+    __version__ = "0.0.0"
+
+__all__ = ["__version__"]

pipecat_guardrails-0.0.1/tests/test_package.py

@@ -0,0 +1,15 @@
+from importlib.metadata import version
+
+import pipecat_guardrails
+
+
+def test_version_matches_installed_metadata():
+    assert pipecat_guardrails.__version__ == version("pipecat-guardrails")
+
+
+def test_pipecat_classifier_interface_is_available():
+    # Layers 2 and 3 (classifier and LLM judge) are built on this interface.
+    from pipecat.classifiers.base_classifier import BaseClassifier, YesNoQuestion
+
+    assert hasattr(BaseClassifier, "yes_no")
+    assert YesNoQuestion(instructions="Is this a test?").instructions == "Is this a test?"