pipecat-ai-tail 0.0.0.dev0__tar.gz

pipecat_ai_tail-0.0.0.dev0/.github/ISSUE_TEMPLATE/1-bug_report.yml

@@ -0,0 +1,105 @@
+name: Bug report
+description: Report a bug or unexpected behavior
+type: Bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Bug Report
+
+        Thank you for taking the time to fill out this bug report.
+
+  - type: markdown
+    attributes:
+      value: |
+        ### Environment
+
+  - type: input
+    id: tail-version
+    attributes:
+      label: tail version
+      description: Which version are you using?
+      placeholder: e.g., 0.0.1
+    validations:
+      required: true
+
+  - type: input
+    id: pipecat-version
+    attributes:
+      label: tail version
+      description: Which Pipecat version are you using?
+      placeholder: e.g., 0.0.81
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python version
+      description: Which Python version are you using?
+      placeholder: e.g., 3.12.8
+    validations:
+      required: true
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: Which OS are you using?
+      placeholder: e.g., Ubuntu 24.04, Windows 11, macOS 12.5
+    validations:
+      required: true
+
+  - type: input
+    id: browser
+    attributes:
+      label: Browser
+      description: Which browser are you using?
+      placeholder: e.g., Chrome 139.0.7258.127
+    validations:
+      required: true
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Issue description
+      description: Provide a clear description of the issue.
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro
+    attributes:
+      label: Reproduction steps
+      description: List the steps to reproduce the issue.
+      placeholder: |
+        1. Do this...
+        2. Then do that...
+        3. Observe the error...
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior
+      description: What actually happened?
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: If applicable, include any relevant logs or error messages
+      render: shell
+    validations:
+      required: false

pipecat_ai_tail-0.0.0.dev0/.github/ISSUE_TEMPLATE/2-question.yml

@@ -0,0 +1,85 @@
+name: Question
+description: Ask a question or get help
+type: Question
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Question
+
+        Use this form to ask a question about pipecat.
+
+  - type: markdown
+    attributes:
+      value: |
+        ### Environment (if applicable)
+
+  - type: input
+    id: tail-version
+    attributes:
+      label: tail version
+      description: Which version are you using?
+      placeholder: e.g., 0.0.1
+    validations:
+      required: true
+
+  - type: input
+    id: pipecat-version
+    attributes:
+      label: tail version
+      description: Which Pipecat version are you using?
+      placeholder: e.g., 0.0.81
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python version
+      description: Which Python version are you using? (if applicable)
+      placeholder: e.g., 3.12.8
+    validations:
+      required: false
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: Which OS are you using? (if applicable)
+      placeholder: e.g., Ubuntu 24.04, Windows 11, macOS 12.5
+    validations:
+      required: false
+
+  - type: input
+    id: browser
+    attributes:
+      label: Browser
+      description: Which browser are you using?
+      placeholder: e.g., Chrome 139.0.7258.127
+    validations:
+      required: false
+
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: Provide your question in detail here.
+    validations:
+      required: true
+
+  - type: textarea
+    id: tried
+    attributes:
+      label: What I've tried
+      description: Describe what you've already tried or research you've done.
+      placeholder: I've looked at the documentation and tried...
+    validations:
+      required: false
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Context
+      description: Any additional context or information that might help others understand your question better.
+    validations:
+      required: false

pipecat_ai_tail-0.0.0.dev0/.github/ISSUE_TEMPLATE/3-feature_request.yml

@@ -0,0 +1,52 @@
+name: Feature request
+description: Suggest an enhancement or new feature
+type: Enhancement
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Feature Request
+
+        Thank you for suggesting an enhancement to pipecat.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Statement
+      description: A clear description of the problem this feature would solve.
+      placeholder: I'm always frustrated when...
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternative Solutions
+      description: Any alternative solutions or features you've considered.
+    validations:
+      required: false
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any other context, mockups, or screenshots about the feature request here.
+      placeholder: You can drag and drop images here to include them.
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: contribution
+    attributes:
+      label: Would you be willing to help implement this feature?
+      options:
+        - label: Yes, I'd like to contribute
+        - label: No, I'm just suggesting

pipecat_ai_tail-0.0.0.dev0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

pipecat_ai_tail-0.0.0.dev0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1 @@
+#### Please describe the changes in your PR. If it is addressing an issue, please reference that as well.

pipecat_ai_tail-0.0.0.dev0/.github/workflows/build.yaml

@@ -0,0 +1,39 @@
+name: build
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "**"
+      - "ui/**"
+
+concurrency:
+  group: build-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: "Build and Install"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install development dependencies
+        run: uv sync --group dev
+
+      - name: Build project
+        run: uv build
+
+      - name: Install project in editable mode
+        run: uv pip install --editable .

pipecat_ai_tail-0.0.0.dev0/.github/workflows/format.yaml

@@ -0,0 +1,43 @@
+name: format
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - "**"
+    paths-ignore:
+      - "ui/**"
+
+concurrency:
+  group: build-format-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ruff-format:
+    name: "Python code quality checks"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install development dependencies
+        run: uv sync --group dev
+
+      - name: Ruff formatter
+        id: ruff-format
+        run: uv run ruff format --diff
+
+      - name: Ruff linter (all rules)
+        id: ruff-check
+        run: uv run ruff check

pipecat_ai_tail-0.0.0.dev0/.github/workflows/publish.yaml

@@ -0,0 +1,60 @@
+name: publish
+
+on:
+  workflow_dispatch:
+    inputs:
+      gitref:
+        type: string
+        description: "what git tag to build (e.g. v0.0.1)"
+        required: true
+
+jobs:
+  build:
+    name: "Build and upload wheels"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.inputs.gitref }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.10
+
+      - name: Install development dependencies
+        run: uv sync --group dev
+
+      - name: Build project
+        run: uv build
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels
+          path: ./pipecat/dist
+
+  publish-to-pypi:
+    name: "Publish to PyPI"
+    runs-on: ubuntu-latest
+    needs: [ build ]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pipecat-ai-tail
+    permissions:
+      id-token: write
+    steps:
+      - name: Download wheels
+        uses: actions/download-artifact@v4
+        with:
+          name: wheels
+          path: ./dist
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          verbose: true
+          print-hash: true

pipecat_ai_tail-0.0.0.dev0/.gitignore

@@ -0,0 +1,34 @@
+.vscode
+.idea
+env/
+__pycache__/
+*~
+venv
+.venv
+#*#
+
+# 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
+.DS_Store
+.env
+.envrc
+
+# uv
+.python-version

pipecat_ai_tail-0.0.0.dev0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to **Tail** will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2025-10-02
+
+Initial public release.

pipecat_ai_tail-0.0.0.dev0/CHANGELOG.md.template

@@ -0,0 +1,62 @@
+# Changelog
+
+All notable changes to the **<project name>** SDK will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Please make sure to add your changes to the appropriate categories:
+
+## [Unreleased]
+
+### Added
+
+<!-- for new functionality -->
+
+- n/a
+
+### Changed
+
+<!-- for changed functionality -->
+
+- n/a
+
+### Deprecated
+
+<!-- for soon-to-be removed functionality -->
+
+- n/a
+
+### Removed
+
+<!-- for removed functionality -->
+
+- n/a
+
+### Fixed
+
+<!-- for fixed bugs -->
+
+- n/a
+
+### Performance
+
+<!-- for performance-relevant changes -->
+
+- n/a
+
+### Security
+
+<!-- for security-relevant changes -->
+
+- n/a
+
+### Other
+
+<!-- for everything else -->
+
+- n/a
+
+## [0.1.0] - YYYY-MM-DD
+
+Initial release.

pipecat_ai_tail-0.0.0.dev0/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2025, Daily
+
+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_ai_tail-0.0.0.dev0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: pipecat-ai-tail
+Version: 0.0.0.dev0
+Summary: A pipeline runner for Pipecat
+License-Expression: BSD-2-Clause
+Project-URL: Source, https://github.com/pipecat-ai/tail
+Project-URL: Website, https://pipecat.ai
+Keywords: pipecat,ai
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Communications :: Conferencing
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pipecat-ai>=0.0.87
+Requires-Dist: textual<7,>=6.0.0
+Requires-Dist: textual-plotext<2,>=1.0.0
+Requires-Dist: websockets<15.0,>=13.1
+Dynamic: license-file
+
+<h1><div align="center">
+ <img alt="tail" width="300px" height="auto" src="https://github.com/pipecat-ai/tail/raw/refs/heads/main/tail.png">
+</div></h1>
+
+[![PyPI](https://img.shields.io/pypi/v/pipecat-ai-tail)](https://pypi.org/project/pipecat-ai-tail) [![Discord](https://img.shields.io/discord/1239284677165056021)](https://discord.gg/pipecat)
+
+# ᓚᘏᗢ Tail: A terminal dashboard for Pipecat
+
+**Tail** is a terminal dashboard for the [Pipecat](https://github.com/pipecat-ai/pipecat) voice and multimodal conversational AI framework.
+
+It lets you monitor your Pipecat sessions in real time with logs, conversations, metrics, and audio levels all in one place.
+
+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
+- 🖥️ Run locally as a pipeline runner or connect to a remote session
+
+<p align="center"><img src="https://raw.githubusercontent.com/pipecat-ai/tail/refs/heads/main/tail-image.gif" alt="Tail" width="500"/></p>
+
+## 🧭 Getting started
+
+### Requirements
+
+- Python 3.10+
+- [Pipecat](https://github.com/pipecat-ai/pipecat) installed
+
+### Install Tail for Python
+
+```bash
+uv pip install pipecat-ai-tail
+```
+
+### ⚡ Option A: Pipeline runner
+
+Use `TailRunner` as a drop-in replacement for `PipelineRunner`. For example:
+
+```python
+runner = PipelineRunner()
+
+await runner.run(task)
+```
+
+becomes
+
+```python
+from pipecat_tail.runner import TailRunner
+
+runner = TailRunner()
+
+await runner.run(task)
+```
+
+### 🏠 Option B: Standalone app
+
+You can also start Tail as a standalone application. This lets you connect to a running session, whether local or remote. All you need to do is add the `TailObserver` to your pipeline task:
+
+```python
+from pipecat_tail.observer import TailObserver
+
+task = PipelineTask(..., observers=[TailObserver()])
+```
+
+Then start the app:
+
+```sh
+pctail [--uri URI]
+```
+
+or
+
+```sh
+pipecat-tail [--uri URI]
+```
+
+By default, it will connect to `ws://localhost:9292`.
+
+## 📚 Next steps
+
+- See the [Pipecat documentation](https://docs.pipecat.ai) for more about building bots