Skip to main content

Convenient command line and library wrapper for youtube-dl.

Latest release 20200621:

  • YDL.run: just catch the youtube_dl DownloadError.
  • Changes to the default output filename template.
  • Other minor internal changes.

The youtube-dl tool and associated youtube_dl Python module are very useful for downloading media from various websites. However, as an end user who almost never streams because of my soggy internet link, I find fetching several items is quite serial and visually noisy.

This module provides a command line tool ydl which:

  • runs multiple downloads in parallel with progress bars
  • prints the downloaded filename as each completes

Interactively, I keep this shell function:

ydl(){
  ( set -ue
    dldir=${DL:-$HOME/dl}/v
    [ -d "$dldir" ] || set-x mkdir "$dldir"
    cd "$dldir"
    command ydl ${1+"$@"}
  )
}

which runs the downloader in my preferred download area without tedious manual cding.

Function main(argv=None, cmd=None)

Main command line.

Class OverYDL

A manager for multiple YDL instances.

Class YDL

Manager for a download process.

Method YDL.__init__(self, url, *, fstags, upd=None, tick=None, over_progress=None, **kw_opts)

Initialise the manager.

Parameters:

  • url: the URL to download
  • fstags: mandatory keyword argument, a cs.fstags.FSTags instance
  • upd: optional cs.upd.Upd instance for progress reporting
  • tick: optional callback to indicate state change
  • over_progress: an OverProgress to which to add each new Progress instance
  • kw_opts: other keyword arguments are used to initialise the options for the underlying YoutubeDL instance

Class YDLCommand(cs.cmdutils.BaseCommand)

ydl command line implementation.

Command line usage:

Usage: YDLCommand [-f] {URLs|-}...
    -f  Force download - do not use the cache.

Release Log

Release 20200621:

  • YDL.run: just catch the youtube_dl DownloadError.
  • Changes to the default output filename template.
  • Other minor internal changes.

Release 20200615.1: Add usage message to docstring.

Release 20200615:

  • Initial "daemon" mode, suitable for "tail -f .ydld-queue | ydl -", handy for keeping around in a tmux session.
  • Assorted small bugfixes.

Release 20200521: Initial PyPI release.

Release files for cs.app.ydl 20200621

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cs.app.ydl 20200621
File Size Uploaded
cs.app.ydl-20200621.tar.gz 5.8 kB Details

Release files / cs.app.ydl-20200621.tar.gz

Download URL cs.app.ydl-20200621.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a1208dd26436b7c070511a1125d696199100e0d4ace5a26854a8ca02f579bd56
BLAKE2b-256 checksum
How to use checksums
63780edabc280e8e0e8fb13ee8336d0a091964ac512a10787d2ccf3f292a310f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7

Release history Release notifications | RSS feed

This release

20200621 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page