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):
    voltpath = "downloads"
    os.makedirs(voltpath, exist_ok=True)
    is_audio = not bool(video)
    service = DownloadService(
        url=link,
        path=voltpath,
        quality="360p" if not is_audio else "audio",
        is_audio=is_audio
    )
    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-2025.12.25.6.tar.gz (18.4 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-2025.12.25.6-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gold_dl-2025.12.25.6.tar.gz
Algorithm Hash digest
SHA256 962f47ef2b0ff9ede3e922227285f77b950a611a262710abf15b504c51239b00
MD5 9a7a4bece0a8e893810a20d2300640f9
BLAKE2b-256 5a27876201661f5a6d9c3ccb535e4d59637d52866e0ee7daf7275c8beb8eb8fc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gold_dl-2025.12.25.6-py3-none-any.whl
  • Upload date:
  • Size: 19.6 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-2025.12.25.6-py3-none-any.whl
Algorithm Hash digest
SHA256 29aea80942dc1d9f19f3818456e38d255f0130c5370a7677916bbf38cd96e019
MD5 09ddc85afd5d6f9355d3a211a13f6bec
BLAKE2b-256 ea9e84b280b277561be6a0fcb400a84b26f73a7f9d429fde94f6438a27e3d264

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