muzlib 0.3.3

Muzlib is a Python script that allows you to create your own music library.

Muzlib

Muzlib is a Python script that allows you to create your own music library. Music is downloaded from YouTube, and music tags are constructed using data from YouTube, Lrclib, NetEase.

Instalation

Arch Linux [AUR]

You can install python-muzlib from AUR using your favorite AUR helper, for example:

yay -S python-muzlib

From PyPI

Ensure that you have installed FFmpeg.

python -m venv .venv
source .venv/bin/activate
pip install muzlib

Usage

Muzlib can be run directly from the command line. When launched without arguments, it starts an interactive prompt guiding you through the download process. You can also pass arguments to skip prompts entirely.

muzlib-cli [-h] [-l LIBRARY_PATH] [-d {album,artist,song}]
        [--artist ARTIST] [--album ALBUM] [--song SONG]
        [--non_interactive]

Arguments

Argument	Short	Description
--help	-h	Show help message and exit.
--library_path PATH	-l	Root directory to save downloaded music. Defaults to your OS standard Music folder.
--download_type {album,artist,song}	-d	Scope of the download: artist (full discography), album (specific release), or song (single track).
--artist ARTIST		Target artist's name. Highly recommended for all download types to ensure accurate search results.
--album ALBUM		Target album's title. Use alongside --artist when --download_type is album.
--song SONG		Target song's title. Use alongside --artist when --download_type is song.
--non_interactive		Bypass all user prompts and automatically download the top search result. Requires --download_type to be set.

Examples

Interactive mode

launches a menu to guide you through the download

muzlib-cli

Download an artist's full discography non-interactively

muzlib-cli -d artist --artist "Ludwig Göransson" --non_interactive

Download a specific album

muzlib-cli -d album --artist "Ludwig Göransson" --album "Oppenheimer" --non_interactive

Download a single song into a custom library folder

muzlib-cli -l ~/Music -d song --artist "Ludwig Göransson" --song "Can You Hear The Music" --non_interactive

[!NOTE] --non_interactive requires --download_type to be specified, otherwise muzlib will exit with an error.

Available classes

There is only one (for now) class that can be used:

1. Muzlib(library_path: str, skip_downloaded=False): library class that uses YouTube Music metadata (100% accuracy, but sometimes poor quality metadata)

Available methods

Backup library

Muzlib.backup_library() -> str

This function creates backup of library (even with user-changed tags). Creates file .muzlib/muzlib_backup_***.json and returns path to it.

Restore library

This function downloads track and set metadata from bacup file.

Muzlib.backup_library(backup_filepath: str)

• backup_filepath: path of the file created by Muzlib.backup_library().

Troubleshooting

[!WARNING] If you encounter issues with yt-dlp, you can replace default cookies at assets/cookies.txt as described at this guide.