onnowhere / youtube_music_playlist_downloader

YouTube Music Playlist Downloader

YouTube Music Playlist Downloader

This program automatically downloads & updates a local copy of any YouTube playlist in the form of a music album folder

• Songs are stored in album folders named by playlist title
• Existing albums are updated with any new or missing songs
• Songs no longer in the playlist are moved to end of album
• Song metadata is automatically generated using video info
• Metadata includes Title/Artists/Album/Lyrics/Track Number
• Cover art for songs are created by using video thumbnails

[NOTE] This program and ffmpeg may be blocked by antivirus. If you run into any issues, you can try adding this program and your ffmpeg folder to the exclusions of your antivirus.

Requirements

• FFMPEG: Make sure you can run ffmpeg from the command line. If you are on Windows check your PATH.

Install

For Windows, you can directly download the executable from the following link:

Alternatively, you can clone and install from source with Python 3.

git clone https://github.com/onnowhere/youtube_music_playlist_downloader
cd youtube_music_playlist_downloader
pip install -r requirements.txt

Usage

Double click the executable to run and follow the instructions that are presented.

If using the source files, double click the file to run with Python or run from command line.

python youtube_music_playlist_downloader.py

Build

To build the standalone executable, you must have Python and pyinstaller. Once you do, follow the steps below.

python -m pip install -U pyinstaller -r requirements.txt
git submodule init
git submodule update
python scripts/build.py

On some systems, you may need to use py or python3 instead of python.

Config

A .playlist_config.json file is generated for all album folders and contains the following adjustable fields.

Options adjustable using the program

• url: The URL of the playlist to download songs from (default: set during download)
• reverse_playlist: Whether to reverse the order of songs in the playlist when downloading (default: false)
• use_title: Whether to use the title or track name provided by YouTube where possible as the title for downloaded songs (default: true)
• use_uploader: Whether to use the uploader or the artist name provided by YouTube where possible as the artist for downloaded songs (default: true)
• use_playlist_name: Whether to use the playlist or the album name provided by YouTube where possible as the album for downloaded songs (default: true)

Additional options adjustable through the config file

• sync_folder_name: Whether to automatically sync the name of the playlist folder to the YouTube playlist name (default: true)
• use_threading: Whether to use threading for faster song downloading and updating at the cost of more CPU and memory usage (default: true)
• thread_count: Number of threads to use for threading - if set to 0, this value will be dynamically determined (default: 0)
• retain_missing_order: Whether to retain the current order of missing or deleted songs if a local copy exists or move them to the end of the album (default: false)
• name_format: The name format used to generate file names in yt-dlp output template format (default: "%(title)s-%(id)s.%(ext)s")
• track_num_in_name: Whether to include the track number at the start of all file names (default: true)
• audio_format: The audio format used by yt-dlp when downloading songs (default: "bestaudio/best")
• audio_codec: The audio codec used by yt-dlp when downloading songs (default: "mp3")
• audio_quality: The audio quality used by yt-dlp when converting audio formats (default: "5")
• image_format: The cover art image format - for better quality but larger file size, use "png" (default: "jpeg")
• lyrics_langs: A list of language codes in order of priority to determine which lyrics to select if any are unavailable - leave empty for automatic selection (default: [])
  • Language codes support regex and are matched to the full string, for example: "en.*" is interpreted as "^en.*$" before regex matching
  • Example: ["en.*", "ja"] means select the first language with prefix en, else select the language that exactly matches ja if it exists
• strict_lang_match: Whether to avoid selecting lyrics automatically given no language matches (default: false)
• cookie_file: The path to the cookie file for yt-dlp to refer to (default: "")
• cookies_from_browser: The name of the browser for yt-dlp to load cookies from (default: "")
• verbose: Whether to enable more verbose debug information from yt-dlp (default: false)
• include_metadata: A mapping of metadata fields and whether to include them in song metadata
  • title: Include title metadata (default: true)
  • cover: Include cover art (default: true)
  • track: Include track number metadata (default: true)
  • artist: Include artist metadata (default: true)
  • album: Include album metadata (default: true)
  • date: Include date metadata (default: true)
  • lyrics: Include lyrics metadata (default: true)
• overrides: A mapping of custom individual song config overrides - additional entries can be added for each song
  • [video_id]: A mapping of overridden config values for this specific song - a unique alphanumeric YouTube video id
    • ...: All config values from above are valid here with exception to url, reverse_playlist, sync_folder_name, use_threading, thread_count, and overrides

License

Licensed under MIT (See LICENSE)

Disclaimer

Please respect the copyright of any videos you download. The creator of this program will not be held liable for any copyright violations caused by the usage of this program.