Metadata-Version: 2.4
Name: voxta-twitch-relay
Version: 0.1.0
Summary: A relay app that bridges Twitch chat with the Voxta conversational AI platform via Voxta Gateway.
Author: Dion Labs
License: MIT
Project-URL: Homepage, https://github.com/dion-labs/voxta-twitch-relay
Project-URL: Documentation, https://twitch.voxta.dionlabs.ai
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Communications :: Chat
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: twitchio<3.0.0,>=2.10.0
Requires-Dist: fastapi>=0.109.0
Requires-Dist: uvicorn[standard]>=0.27.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: voxta-gateway>=0.1.0
Provides-Extra: dev
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: pre-commit>=3.5.0; extra == "dev"
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: coverage-badge>=1.1.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5.0; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.24.0; extra == "docs"
Requires-Dist: pymdown-extensions>=10.0; extra == "docs"
Dynamic: license-file

# Voxta Twitch Relay

[![Build Status](https://github.com/dion-labs/voxta-twitch-relay/actions/workflows/ci.yml/badge.svg)](https://github.com/dion-labs/voxta-twitch-relay/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/dion-labs/voxta-twitch-relay/branch/main/graph/badge.svg)](https://codecov.io/gh/dion-labs/voxta-twitch-relay)
[![PyPI version](https://badge.fury.io/py/voxta-twitch-relay.svg)](https://badge.fury.io/py/voxta-twitch-relay)
[![Python versions](https://img.shields.io/pypi/pyversions/voxta-twitch-relay.svg)](https://pypi.org/project/voxta-twitch-relay/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

A bridge between Twitch chat and the Voxta conversational AI platform. This relay captures Twitch messages and sends them to the [Voxta Gateway](https://github.com/dion-labs/voxta-gateway), allowing your AI to interact with your live audience in real-time.

## Features

- **Seamless Integration**: Relays messages to Voxta Gateway with minimal latency.
- **Smart Queueing**: Automatically queues messages when the AI is not in an active chat session.
- **Bot Filtering**: Easily ignore common bots like Nightbot and StreamElements.
- **Debug Interface**: Built-in web dashboard to monitor relay status and message history.
- **Custom Commands**: Built-in `!voxta` and `!setreply` commands for channel moderators.

## Installation

```bash
pip install voxta-twitch-relay
```

## Quick Start

1. Create a `.env` file with your credentials:

```env
TWITCH_TOKEN=oauth:your_token_here
TWITCH_CLIENT_ID=your_client_id
TWITCH_CHANNEL=your_channel_name
GATEWAY_URL=http://localhost:8081
```

2. Run the relay:

```bash
voxta-twitch-relay
```

3. Access the debug dashboard at `http://localhost:8082`.

## Documentation

For full documentation, visit [twitch.voxta.dionlabs.ai](https://twitch.voxta.dionlabs.ai).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
