Skip to main content

Library GoLD YouTube downloader (video / audio / shorts / playlists) with smart caching and auto quality handling

Project description

gold-dl — The simplest YouTube downloader (CLI + Python API)

Downloads Downloads month version Python Version License PyPI stats

gold-dl screenshot

Table of Contents

  • Installation
  • Upgrade
  • Quick Start (CLI)
  • Options
  • Examples
  • Python API
  • Screenshots
  • Todo
  • Contributing
  • License
  • Badges / Usage

Channel Library : Source Gold
Contact / Developer : @CB6BB

Installation

  1. Verify you have Python 3.x:
python --version
  1. Install gold-dl:
pip install gold-dl --break-system-packages

(If your environment does not require --break-system-packages, you may omit it.)

Upgrade

pip install --upgrade gold-dl --break-system-packages

Quick Start (CLI)

gold-dl "YOUTUBE_LINK" [PATH]
  • "YOUTUBE_LINK" (required) the YouTube video or playlist URL (wrap in quotes).
  • [PATH] (optional) destination folder; defaults to the current working directory.

Common options

  • -v, --version
    • Show current version and exit.
  • -a, --audio
    • Download audio only (skip video selection).
  • -f, --footage
    • Download video only (skip audio-only flows).

Icons used in this README

  • Download
  • Audio
  • Video
  • Folder

Examples

# Download a video (interactive selection if needed)
gold-dl "https://www.youtube.com/watch?v=VIDEO_ID"

# Download audio only
gold-dl "https://www.youtube.com/watch?v=VIDEO_ID" --audio

# Download to a specific folder
gold-dl "https://www.youtube.com/watch?v=VIDEO_ID" ./downloads

# Download a playlist (you can select items or download all)
gold-dl "https://www.youtube.com/playlist?list=PLAYLIST_ID"

Python API (async) Use the async DownloadService to integrate gold-dl into bots and other apps.

from gold_dl import DownloadService
import os
from typing import Union
import asyncio

async def download(bot_username, link, video: Union[bool, str] = None):
    is_audio = not bool(video)
    service = DownloadService(
        url=link,
        path="downloads/%(id)s.%(ext)s",
        quality="360p" if not is_audio else "audio",
        is_audio=is_audio, 
        download_thumbnail=None, 
        export_metadata=None
    )
    return await service.download_async()

# Example runner:
# asyncio.run(download("botname", "https://www.youtube.com/watch?v=VIDEO_ID", video=True))

Screenshots

  • Download video and choose save location
  • Choose download type (audio / video)
  • Select resolution when downloading video
  • Playlist selection UI (pick single video(s) or download all)

Todo

  • Notification System
  • Auto Update package if new version available
  • Support Optional Numbering for Downloaded Playlist Videos
  • Improve code health
  • API (Python)
  • Download Playlist
  • Support setting for default download folder
  • Download thumbnails with videos and audio

Contributing

  • Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
  • Ensure code follows the existing style and add tests where applicable.
  • Update the README and other documentation as necessary.

License

  • See the LICENSE file in the project root (and the PyPI license badge above).

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

gold_dl-2026.1.20.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

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

gold_dl-2026.1.20-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file gold_dl-2026.1.20.tar.gz.

File metadata

  • Download URL: gold_dl-2026.1.20.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for gold_dl-2026.1.20.tar.gz
Algorithm Hash digest
SHA256 af3a38366118da92d7a08422d78ab45796d84603fb5487ff71e86fa7e68e5467
MD5 46c1b892f35aed1b48cc472d1462cb07
BLAKE2b-256 82113adb25cda96eb9e8f35cf74ee3fb3bcdbfad4bc9f1c77e62864e1fe3f413

See more details on using hashes here.

File details

Details for the file gold_dl-2026.1.20-py3-none-any.whl.

File metadata

  • Download URL: gold_dl-2026.1.20-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for gold_dl-2026.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 547c822770ef5942da37ad91f39169a2182ea7dd4d68316f05239d22c246d9c5
MD5 853162420590d0605fedaa7cacc021f6
BLAKE2b-256 17f005b4466be37f6874372e43c93f673c4879beb1e4e98c98a90602b8d2eb87

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