Skip to content

henrique-coder/streamsnapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

376 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

StreamSnapper

PyPI - Version Python Versions License Code Style

Intuitive, high-performance YouTube data extraction library for Python.

πŸš€ Quick Start β€’ πŸ“– API Reference β€’ πŸ’‘ Examples


🌟 Overview

StreamSnapper provides a clean, pythonic interface for extracting YouTube metadata and streams. It wraps yt-dlp with an intuitive object-oriented API, automatic quality enhancements, and robust type safety.

  • Intuitive API: Access data via properties (yt.streams.video.best).
  • Smart Categorization: Videos, audios, and subtitles are automatically sorted and filtered.
  • Modern Tech: Built with pydantic v2 and orjson for high performance.
  • AI Detection: Automatically detects AI-upscaled content.
  • Type Safe: Fully typed for excellent IDE support.

πŸ”§ Installation

uv add streamsnapper

Requirements: Python 3.10+

πŸš€ Quick Start

Basic Usage

from streamsnapper import YouTube

# automatic extraction on initialization
yt = YouTube("https://www.youtube.com/watch?v=dQw4w9WgXcQ")

# Video Metadata
print(f"Title: {yt.metadata.title}")
print(f"Views: {yt.metadata.view_count}")
print(f"Duration: {yt.metadata.duration_formatted}")

# Stream Access (Automatically sorted by quality)
print(f"Best Video: {yt.streams.video.best.url}")
print(f"Best Audio: {yt.streams.audio.best.url}")

Filtering Streams

StreamSnapper offers a readable fluent interface for filtering:

# specific resolution
stream = yt.streams.video.filter(resolution="1080p").best

# specific codec and frame rate
stream = yt.streams.video.filter(codec="vp9", fps=60).best

# High quality audio
stream = yt.streams.audio.filter(min_bitrate=128).best

πŸ’‘ Key Features

Intelligent Thumbnails

We automatically filter and deduplicate thumbnails to give you exactly what you need:

  • yt.metadata.thumbnails: A curated list of high-quality thumbnails (maxres, sd, hq).
  • yt.metadata.all_thumbnails: The complete raw list of all available thumbnails.

AI Upscaling Detection

Detects if a stream has been AI-upscaled (e.g., "1080p Premium" or similar enhancements):

if stream.is_ai_upscaled:
    print("This stream is AI upscaled!")

JSON Serialization

All models support high-performance JSON serialization using orjson:

json_data = yt.metadata.to_json()

πŸ“– API Reference

YouTube Class

The main entry point.

yt = YouTube(
    url="https://...",
    cookies=None,      # Optional: CookieFile or CookieBrowser
    logging=False      # Optional: Enable verbose logging
)

Properties:

  • .metadata: VideoInformation object (title, id, description, stats, etc.)
  • .streams: Streams object containing:
    • .video: VideoStreamCollection
    • .audio: AudioStreamCollection
    • .subtitle: SubtitleStreamCollection

VideoStream Model

Represents a single video format. Key attributes:

  • url: Direct download URL.
  • resolution: string (e.g., "1080p").
  • codec: string (e.g., "vp9").
  • bitrate: float (Mbps/Kbps).
  • is_hdr: boolean.
  • is_ai_upscaled: boolean.

πŸ›‘οΈ Authentication (Premium/Age-Restricted)

Access private or age-restricted content using cookies. Cookies are automatically reused across extraction and all subsequent downloads β€” they are extracted a single time and propagated to every stream, so you never hit unnecessary re-authentication.

from streamsnapper import YouTube, CookieBrowser, CookieFile

# Use cookies from local Chrome browser
yt = YouTube(url, cookies=CookieBrowser.CHROME)

# Use a Netscape-formatted cookie file
yt = YouTube(url, cookies=CookieFile("cookies.txt"))

⬇️ Downloading

Download individual stream

# Download best video-only stream
path = yt.streams.video.best.download(output_path="downloads/")

# Download best audio-only stream
path = yt.streams.audio.best.download(output_path="downloads/")

Default filenames follow the convention:

  • Video-only: <Title> (video-only) [yt-<ID>].ext
  • Audio-only: <Title> (audio-only) [yt-<ID>].ext

Download and merge (video + audio)

YouTube separates high-quality video and audio into distinct streams. Use download_with_audio to merge them automatically with ffmpeg:

video = yt.streams.video.best
audio = yt.streams.audio.best

# Merge and save β€” requires ffmpeg in PATH
path = video.download_with_audio(audio=audio, output_path="downloads/")
# Result filename: <Title> [yt-<ID>].ext

Note

ffmpeg must be installed and available in your system PATH for merging to work.

πŸ“ License

MIT License - see LICENSE file.

About

Extract and analyze YouTube video streams with intelligent quality selection, language fallback, and comprehensive metadata retrieval.

Topics

Resources

License

Stars

Watchers

Forks

Contributors