Skip to content

404-5971/ytscript

Repository files navigation

YTScript 🎥 → 📝

Python uv yt-dlp OpenAI Whisper Hugging Face

A powerful Python tool that transcribes and summarizes YouTube videos using OpenAI's Whisper for transcription and state-of-the-art language models for summarization.

Features

  • 🎯 Accurate Transcription: Uses OpenAI's Whisper model for high-quality speech-to-text conversion
  • 📝 Smart Summarization: Generates concise, meaningful summaries using advanced language models
  • 🌐 Flexible Model Options: Choose between local models or Hugging Face's API
  • 🚀 Easy to Use: Simple command-line interface with sensible defaults
  • 💾 Resource Efficient: Optimized for both high-end and resource-constrained systems

System Requirements

  • Operating System: Linux, macOS, or Windows
  • Python 3.10 or higher (if building from source)
  • Internet connection (for model downloads and Hugging Face API)

Installation

Method 1: Pre-built Binary (Recommended)

  1. Download the appropriate binary for your system from the releases page
  2. Make the file executable (Unix systems):
    chmod +x ytscript
  3. Move to a directory in your PATH:
    sudo mv ytscript /usr/local/bin/

Method 2: Build from Source

See our detailed build instructions for compiling from source code.

Documentation

Example Usage

# Basic transcription
ytscript "https://youtu.be/example" --model tiny

# Transcribe and summarize using a local model
ytscript "https://youtu.be/example" --summarize true

# Use Hugging Face for summarization
ytscript "https://youtu.be/example" --summarize true --summarizationModelType huggingface

Development

Testing

# Run all tests
make test

# Run specific test file
python -m pytest tests/test_transcription.py -v

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

Support

About

A CLI to transcribe and summerize youtube videos

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published