Adding a new example to exemplify the bot-output RTVI event

code-helper/.gitignore

@@ -0,0 +1,227 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# 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
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Node.js (client/)
+client/node_modules/
+client/.next/
+client/out/
+client/dist/
+client/.vite/
+client/.turbo/
+client/.vercel
+client/.env*.local
+client/*.tsbuildinfo

code-helper/README.md

@@ -0,0 +1,142 @@
+# code-helper
+
+A Pipecat AI voice agent built with a cascade pipeline (STT → LLM → TTS).
+
+## Configuration
+
+- **Bot Type**: Web
+- **Transport(s)**: SmallWebRTC
+- **Pipeline**: Cascade
+  - **STT**: Deepgram
+  - **LLM**: OpenAI
+  - **TTS**: ElevenLabs
+- **Features**:
+  - Transcription
+  - smart-turn v3
+  - Observability (Whisker + Tail)
+
+## Setup
+
+### Server
+
+1. **Navigate to server directory**:
+
+   ```bash
+   cd server
+   ```
+
+2. **Install dependencies**:
+
+   ```bash
+   uv sync
+   ```
+
+3. **Configure environment variables**:
+
+   ```bash
+   cp .env.example .env
+   # Edit .env and add your API keys
+   ```
+
+4. **Run the bot**:
+
+   - SmallWebRTC: `uv run bot.py`
+
+### Client
+
+1. **Navigate to client directory**:
+
+   ```bash
+   cd client
+   ```
+
+2. **Install dependencies**:
+
+   ```bash
+   npm install
+   ```
+
+3. **Run development server**:
+
+   ```bash
+   npm run dev
+   ```
+
+4. **Open browser**:
+
+   http://localhost:5173
+
+## Project Structure
+
+```
+code-helper/
+├── server/              # Python bot server
+│   ├── bot.py           # Main bot implementation
+│   ├── pyproject.toml   # Python dependencies
+│   ├── .env.example     # Environment variables template
+│   ├── .env             # Your API keys (git-ignored)
+│   └── ...
+├── client/              # Vanilla application
+│   ├── src/             # Client source code
+│   ├── package.json     # Node dependencies
+│   └── ...
+├── .gitignore           # Git ignore patterns
+└── README.md            # This file
+```
+## Observability
+
+This project includes observability tools to help you debug and monitor your bot:
+
+### Whisker - Live Pipeline Debugger
+
+**Whisker** is a live graphical debugger that lets you visualize pipelines and debug frames in real time.
+
+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
+- 🔍 Filter frames by name to quickly find the ones you care about
+- 🧵 Select a frame to trace its full path through the pipeline
+- 💾 Save and load previous sessions for review and troubleshooting
+
+**To use Whisker:**
+
+1. Run an ngrok tunnel to expose your bot:
+
+   ```bash
+   ngrok http 9090
+   ```
+
+   > Tip: Use `--subdomain` for a repeatable ngrok URL
+
+2. Navigate to [https://whisker.pipecat.ai/](https://whisker.pipecat.ai/) and enter your ngrok URL (e.g., `your-subdomain.ngrok.io`)
+
+3. Once your bot is running, press connect
+
+### Tail - Terminal Dashboard
+
+**Tail** is a terminal dashboard that lets you monitor your Pipecat sessions in real time.
+
+With Tail you can:
+
+- 📜 Follow system logs in real time
+- 💬 Track conversations as they happen
+- 🔊 Monitor user and agent audio levels
+- 📈 Keep an eye on service metrics and usage
+
+**To use Tail:**
+
+1. Run your bot (in one terminal)
+
+2. Launch Tail in another terminal:
+   ```bash
+   pipecat tail
+   ```
+
+## Learn More
+
+- [Pipecat Documentation](https://docs.pipecat.ai/)
+- [Pipecat GitHub](https://github.com/pipecat-ai/pipecat)
+- [Pipecat Examples](https://github.com/pipecat-ai/pipecat-examples)
+- [Discord Community](https://discord.gg/pipecat)