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.7.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.7-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gold_dl-2025.12.25.7.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.7.tar.gz
Algorithm Hash digest
SHA256 531e53a16241af737d5734fe2fa6a58ecd52dee47bf8f8e6f1b1f68656af7f93
MD5 f35e3468f5144c096db88a7d6874021d
BLAKE2b-256 0cd6cc1de3a8a1353d5bb57c3cec2b4914dca7c3d417c17c3186d90fe3d9e0cc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gold_dl-2025.12.25.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f808a84efb7778b8fe52a74e2bfbaa2ac5cd0baa02741a81e9ae6025262828fa
MD5 9d5c1e3359217650b70f60c09d164c3d
BLAKE2b-256 8c04a939e3e5de5d5d407a2b6fb7c8b606b121c4d12066434c656887bc9d6149

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