| Name | pipecat-ai-whisker JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | None |
| Summary | A real-time debugger for Pipecat |
| upload_time | 2025-08-29 21:47:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
pipecat
debug
ai
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1><div align="center">
<img alt="whisker" width="300px" height="auto" src="https://github.com/pipecat-ai/whisker/raw/refs/heads/main/whisker.png">
</div></h1>
[](https://pypi.org/project/pipecat-ai-whisker) [](https://discord.gg/pipecat)
# ααα’ Whisker: A Pipecat Debugger
**Whisker** is a live graphical debugger for the [Pipecat](https://github.com/pipecat-ai/pipecat) voice and multimodal conversational AI framework.
It lets you **visualize pipelines and debug frames in real time** β so you can see exactly what your bot is thinking and doing.
With **Whisker** you can:
- πΊοΈ View a live graph of your pipeline.
- β‘ Watch frame processors flash in real time as frames pass through them.
- π Select a processor to inspect the frames it has handled (both pushed and processed).
- π Filter frames by name to quickly find the ones you care about.
- 𧡠Select a frame to trace its full path through the pipeline.
Think of Whisker as **trace logging with batteries**.
<p align="center"><img src="https://raw.githubusercontent.com/pipecat-ai/whisker/refs/heads/main/whisker-image.png" alt="Whisker" width="500"/></p>
## π§ Getting started
**Requirements:**
* Python 3.10+
* [Pipecat](https://github.com/pipecat-ai/pipecat) installed
* Node.js 20+ (for the UI)
### 1. Install Whisker for Python
```bash
uv pip install pipecat-ai-whisker
```
### 2. Add Whisker to your Pipecat pipeline
```python
from pipecat_whisker import WhiskerObserver
pipeline = Pipeline(...)
whisker = WhiskerObserver(pipeline)
task = PipelineTask(..., observers=[whisker])
```
This starts the Whisker server that the graphical UI will connect to. By default, the Whisker server runs at:
```
ws://localhost:9090
```
## π Running the debugger UI
Clone the repository:
```bash
git clone https://github.com/pipecat-ai/whisker.git
```
Then, start Whisker with:
```bash
cd ui
npm install
npm run dev
```
and connect to [http://localhost:5173](http://localhost:5173).
## π Next steps
* View some examples in the [`examples`](pipecat/examples/) folder
* See the [Pipecat documentation](https://docs.pipecat.ai) for more about building bots
Raw data
{
"_id": null,
"home_page": null,
"name": "pipecat-ai-whisker",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "pipecat, debug, ai",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ac/fe/4336e3f945e0737994258b743fba8687626647b5664c7b8307a8d9a8412e/pipecat_ai_whisker-0.0.6.tar.gz",
"platform": null,
"description": "<h1><div align=\"center\">\n <img alt=\"whisker\" width=\"300px\" height=\"auto\" src=\"https://github.com/pipecat-ai/whisker/raw/refs/heads/main/whisker.png\">\n</div></h1>\n\n[](https://pypi.org/project/pipecat-ai-whisker) [](https://discord.gg/pipecat)\n\n# \u14da\u160f\u15e2 Whisker: A Pipecat Debugger\n\n**Whisker** is a live graphical debugger for the [Pipecat](https://github.com/pipecat-ai/pipecat) voice and multimodal conversational AI framework.\n\nIt lets you **visualize pipelines and debug frames in real time** \u2014 so you can see exactly what your bot is thinking and doing.\n\nWith **Whisker** you can:\n\n- \ud83d\uddfa\ufe0f View a live graph of your pipeline.\n- \u26a1 Watch frame processors flash in real time as frames pass through them.\n- \ud83d\udccc Select a processor to inspect the frames it has handled (both pushed and processed).\n- \ud83d\udd0d Filter frames by name to quickly find the ones you care about.\n- \ud83e\uddf5 Select a frame to trace its full path through the pipeline.\n\nThink of Whisker as **trace logging with batteries**.\n\n<p align=\"center\"><img src=\"https://raw.githubusercontent.com/pipecat-ai/whisker/refs/heads/main/whisker-image.png\" alt=\"Whisker\" width=\"500\"/></p>\n\n## \ud83e\udded Getting started\n\n**Requirements:**\n\n* Python 3.10+\n* [Pipecat](https://github.com/pipecat-ai/pipecat) installed\n* Node.js 20+ (for the UI)\n\n### 1. Install Whisker for Python\n\n```bash\nuv pip install pipecat-ai-whisker\n```\n\n### 2. Add Whisker to your Pipecat pipeline\n\n```python\nfrom pipecat_whisker import WhiskerObserver\n\npipeline = Pipeline(...)\n\nwhisker = WhiskerObserver(pipeline)\n\ntask = PipelineTask(..., observers=[whisker])\n```\n\nThis starts the Whisker server that the graphical UI will connect to. By default, the Whisker server runs at:\n\n```\nws://localhost:9090\n```\n\n## \ud83d\ude80 Running the debugger UI\n\nClone the repository:\n\n```bash\ngit clone https://github.com/pipecat-ai/whisker.git\n```\n\nThen, start Whisker with:\n\n```bash\ncd ui\nnpm install\nnpm run dev\n```\n\nand connect to [http://localhost:5173](http://localhost:5173).\n\n## \ud83d\udcda Next steps\n\n* View some examples in the [`examples`](pipecat/examples/) folder\n* See the [Pipecat documentation](https://docs.pipecat.ai) for more about building bots\n",
"bugtrack_url": null,
"license": null,
"summary": "A real-time debugger for Pipecat",
"version": "0.0.6",
"project_urls": {
"Source": "https://github.com/pipecat-ai/whisker",
"Website": "https://pipecat.ai"
},
"split_keywords": [
"pipecat",
" debug",
" ai"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "82d6b93bf05f35cc14f9b891b55a509d97ef4fbda95828adc546b70973c2eca7",
"md5": "253e344f8d461ae29fe9041277097dd6",
"sha256": "31d317d425f9ab3f6a8eaf7aca8ef172a10b752958ef1a9f390c7d8686fb6b21"
},
"downloads": -1,
"filename": "pipecat_ai_whisker-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "253e344f8d461ae29fe9041277097dd6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7758,
"upload_time": "2025-08-29T21:47:01",
"upload_time_iso_8601": "2025-08-29T21:47:01.517587Z",
"url": "https://files.pythonhosted.org/packages/82/d6/b93bf05f35cc14f9b891b55a509d97ef4fbda95828adc546b70973c2eca7/pipecat_ai_whisker-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "acfe4336e3f945e0737994258b743fba8687626647b5664c7b8307a8d9a8412e",
"md5": "79a68fc2d00949915909ee5f69ea2e88",
"sha256": "fff9338b25f309d51dd2896fd94f5d7cad5e45cbe75a1cfd1abe885fc5e20602"
},
"downloads": -1,
"filename": "pipecat_ai_whisker-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "79a68fc2d00949915909ee5f69ea2e88",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 136791,
"upload_time": "2025-08-29T21:47:03",
"upload_time_iso_8601": "2025-08-29T21:47:03.097335Z",
"url": "https://files.pythonhosted.org/packages/ac/fe/4336e3f945e0737994258b743fba8687626647b5664c7b8307a8d9a8412e/pipecat_ai_whisker-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-29 21:47:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pipecat-ai",
"github_project": "whisker",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pipecat-ai-whisker"
}
