Skip to main content

A Python CLI app for downloading YouTube Music songs with tags from YouTube Music

Project description

Glomatico's YouTube Music Downloader

A Python CLI app for downloading YouTube Music songs with tags from YouTube Music.

Discord Server: https://discord.gg/aBjMEZ9tnq

Why not just use yt-dlp directly?

While this project uses yt-dlp internally, it has the advantage of using YouTube Music's API to get the metadata for songs, which includes the proper high-resolution square cover, lyrics, track number, total tracks, etc.

Prerequisites

Installation

Install the package gytmdl using pip:

pip install gytmdl

Usage

gytmdl [OPTIONS] URLS...

Examples

  • Download a song:
    gytmdl "https://music.youtube.com/watch?v=3BFTio5296w"
    
  • Download an album:
    gytmdl "https://music.youtube.com/playlist?list=OLAK5uy_lvpL_Gr_aVEq-LaivwJaSK5EbFd4HeamM"
    
  • Choose which albums or singles to download from an artist:
    gytmdl "https://music.youtube.com/channel/UCwZEU0wAwIyZb4x5G_KJp2w"
    

Songs that are not part of album (standard YouTube videos) are not supported. To make sure you get valid links, use YouTube Music for searching and enable filtering by songs, albums or artists.

Interactive prompt controls

  • Arrow keys - Move selection
  • Space - Toggle selection
  • Ctrl + A - Select all
  • Enter - Confirm selection

Configuration

gytmdl can be configured by using the command line arguments or the config file.

The config file is created automatically when you run gytmdl for the first time at ~/.gytmdl/config.json on Linux and %USERPROFILE%\.gytmdl\config.json on Windows.

Config file values can be overridden using command line arguments.

Command line argument / Config file key Description Default value
--save-cover, -s / save_cover Save cover as a separate file. false
--overwrite / overwrite Overwrite existing files. false
--read-urls-as-txt, -r / - Interpret URLs as paths to text files containing URLs separated by newlines. false
--config-path / - Path to config file. <home>/.gytmdl/config.json
--log-level / log_level Log level. INFO
--print-exceptions / print_exceptions Print exceptions. false
--output-path, -o / output_path Path to output directory. ./YouTube Music
--temp-path / temp_path Path to temporary directory. ./temp
--cookies-path, -c / cookies_path Path to .txt cookies file. null
--ffmpeg-path / ffmpeg_path Path to FFmpeg binary. ffmpeg
--aria2c-path / aria2c_path Path to aria2c binary. aria2c
--download-mode / download_mode Download mode. ytdlp
--itag, -i / itag Itag (audio codec/quality). 140
--cover-size / cover_size Cover size. 1200
--cover-format / cover_format Cover format. jpg
--cover-quality / cover_quality Cover JPEG quality. 94
--template-folder / template_folder Template of the album folders as a format string. {album_artist}/{album}
--template-file / template_file Template of the song files as a format string. {track:02d} {title}
--template-date / template_date Date tag template. %Y-%m-%dT%H:%M:%SZ
--exclude-tags, -e / exclude_tags Comma-separated tags to exclude. null
--truncate / truncate Maximum length of the file/folder names. null
--no-config-file, -n / - Don't load the config file. false

Tag variables

The following variables can be used in the template folder/file and/or in the exclude_tags list:

  • album
  • album_artist
  • artist
  • cover
  • date
  • lyrics
  • media_type
  • rating
  • title
  • track
  • track_total
  • url

Itags (audio codec/quality)

The following free itags are available:

  • 140 (AAC 128kbps)
  • 139 (AAC 48kbps)
  • 251 (Opus 128kbps)
  • 250 (Opus 64kbps)
  • 249 (Opus 48kbps)

The following premium itags are available if provided a cookies file with an active subscription:

  • 141 (AAC 256kbps)
  • 774 (Opus 256kbps)

Download modes

The following modes are available:

Cover formats

The following cover formats are available:

  • jpg
  • png
  • raw
    • This format gets the raw cover without any processing.
    • Note that when using this format, the cover image will not be embedded within the files. To address this, you can enable the save_cover option to save the cover as a separate file.

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

gytmdl-2.0.1.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

gytmdl-2.0.1-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file gytmdl-2.0.1.tar.gz.

File metadata

  • Download URL: gytmdl-2.0.1.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for gytmdl-2.0.1.tar.gz
Algorithm Hash digest
SHA256 7a0c296f39734dc362cab6af0d550fb9ae0f7205e86f460687c3ecdbaf9ee254
MD5 f332045e53bdcde616142454ff405073
BLAKE2b-256 bcdda893f322affcccfa0011948219d079c172d603e33c6185386dc1ba418f6e

See more details on using hashes here.

File details

Details for the file gytmdl-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: gytmdl-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for gytmdl-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ca91326daaf7c71251a8c376183105300a77e58dd06c5a8710c578736875ced0
MD5 0f3a0411c04735743e113bc383bb97cc
BLAKE2b-256 8f5a093b40ad3510bffb2be00160ac7b7aaffcb0a9d92478cc44c096d7908ace

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page