Skip to content

πŸ”§ Installation

πŸ“‹ Prerequisites

  • 🐍 Python 3.11+
  • πŸ“¦ uv package manager
  • πŸ“½οΈ FFmpeg (for audio processing)
  • πŸ“‘ Redis (for streaming mode)
  • 🌐 Node.js (optional, for frontend development)

πŸ“₯ Install with uv

# Clone the repository
git clone <repository-url>
cd talk2scene

# Install dependencies
uv sync

# Install with dev dependencies
uv sync --extra dev

# Install with docs dependencies
uv sync --extra docs

πŸ“‘ Redis Setup

# Install Redis
sudo apt install redis-server

# Start Redis
sudo systemctl start redis

# Verify
redis-cli ping

πŸ“½οΈ FFmpeg Setup

# Ubuntu/Debian
sudo apt install ffmpeg

# Verify
ffmpeg -version

βœ… Verify Installation

uv run talk2scene --help