Skip to main content

Summarize YouTube videos using AI (OpenAI or Anthropic)

Project description

YouTube Summariser

A command-line tool that summarizes YouTube videos using AI. It extracts transcripts from YouTube videos and generates structured summaries using OpenAI or Anthropic models.

Installation

pip install youtube-summariser

Or install from source:

git clone https://github.com/weijianzhg/youtube-summariser
cd youtube-summariser
pip install -e .

Configuration

API Keys

Set your API key for your preferred provider:

# For OpenAI
export OPENAI_API_KEY=your_openai_api_key

# For Anthropic
export ANTHROPIC_API_KEY=your_anthropic_api_key

Or create a .env file in your working directory:

OPENAI_API_KEY=your_openai_api_key
# or
ANTHROPIC_API_KEY=your_anthropic_api_key

Default Provider

The default provider is Anthropic. You can override this per command using --provider.

Usage

# Basic usage - saves summary to auto-generated filename
youtube-summariser "https://www.youtube.com/watch?v=VIDEO_ID"

# Specify output filename
youtube-summariser "https://youtu.be/VIDEO_ID" -o my_summary.txt

# Print to terminal only (no file saved)
youtube-summariser "https://youtube.com/watch?v=VIDEO_ID" --no-save

# Use a specific provider
youtube-summariser "https://youtu.be/VIDEO_ID" --provider openai

Options

Flag Description
-o, --output Specify output filename (default: summary_<video_id>_<timestamp>.txt)
--no-save Print summary to terminal without saving to file
--provider LLM provider to use: openai or anthropic
-v, --version Show version number
-h, --help Show help message

Output Format

YouTube Video Summary
=====================
Video URL: https://www.youtube.com/watch?v=VIDEO_ID
Video ID: VIDEO_ID
Generated: 2025-01-01 14:30:00
Model: anthropic / claude-sonnet-4-20250514

## Main Topics
...

## Key Points
...

## Detailed Summary
...

## Notable Quotes
...

## Timestamps for Important Moments
...

Requirements

  • Python 3.10+
  • An API key for OpenAI or Anthropic

License

MIT License - see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

youtube_summariser-0.1.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

youtube_summariser-0.1.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file youtube_summariser-0.1.0.tar.gz.

File metadata

  • Download URL: youtube_summariser-0.1.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for youtube_summariser-0.1.0.tar.gz
Algorithm Hash digest
SHA256 4fc5189ebe62dac414124410ea8a073bb34b769cf7f3982e847b70b73b560955
MD5 1e644e23e2d52637190f8039847c33a4
BLAKE2b-256 470f61832f31464f61ed28da8c5cc50f6adadfb4b1b11a8249d600113aba6693

See more details on using hashes here.

File details

Details for the file youtube_summariser-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for youtube_summariser-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8cb031b538709eb7b55898ebfbef89cc1c9afd25d1e73389020b94030f00a34e
MD5 242ffc034b0637c60535d96e02416d60
BLAKE2b-256 919138cb643bec39290961d03fbb9bced485d0eef5d27ef33afb8229b17ac954

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page