Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.52 KB

README.md

File metadata and controls

93 lines (67 loc) · 3.52 KB

Musiclib

Musiclib 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 and Spotify.

Instalation

Ensure that you have installed FFmpeg.

git clone https://github.com/ezvezdov/musiclib
cd musiclib/
python -m venv .venv
source .venv/bin/activate
pip install yt_dlp ytmusicapi spotipy mutagen syncedlyrics

Usage

You can simply download discography of artist (Spotify API by default).

python musiclib.py
>>> Please enter the path for music library: ...
>>> Please enter artist name: ...

This script creates a simple database (.musiclib/db.json) to track downloaded tracks, allowing you to update an artist's discography without re-downloading existing tracks.

Available clases

There are two classes that can be used:

  • Musiclib(library_path: str): library class that uses YouTube Music metadata.
  • MusiclibS(library_path: str): library class that uses Spotify metadata.

Tip

Use MusiclibS for improved performance

Available methods

Downloading artist's discography

Musiclib.download_artist_discography(artist_name: str, download_top_result=False)

  • artist_name: Name of artist as a string.
  • download_top_result: If set to True, choose the first matching artist automatically. By default (False), it will prompt you to confirm if the match is correct.

Downloading album

Musiclib.download_album_by_name(search_term: str, download_top_result=False)

  • search_term: The search query as a string. It is recommended to use the format: "artist1, artist2 - album_name".
  • download_top_result: If set to True, downloads the first matching result automatically. By default (False), it will prompt you to confirm if the match is correct.

Download track

Musiclib.download_track_by_name(search_term: str, download_top_result=False)

  • search_term: The search query as a string. It is recommended to use the format: "artist1, artist2 - track_name".
  • download_top_result: If set to True, downloads the first matching result automatically. By default (False), it will prompt you to confirm if the match is correct.

Backup library

Musiclib.backup_library() -> str

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

Restore library

This function downloads track and set metadata from bacup file.

Musiclib.backup_library(backup_filepath: str)

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

Example of use

You can use Musiclib/MusiclibS class in source code this way

import musiclib
ml = musiclib.Musiclib("Music")
ml.download_track_by_name("Ludwig Göransson - Can You Hear The Music")
ml.download_track_by_name("Ludwig Göransson - Destroyer Of Worlds", download_top_result=True)
# ml.download_artist_discography("Ludwig Göransson") 
backup_path = ml.backup_library()

ml2 = musiclib.MusiclibS("Music2")
ml2.restore_library(backup_path)

After running this code, the Music and Music2 folders will be identical, each containing two tracks by Ludwig Göransson.

Troubleshooting

Warning

If you encounter issues with the Spotify API, you can provide your API key in the api_key.py file.

  1. Generate client_id and client_secret at developer.spotify.com.
  2. Pass this data to the api_key.py file.

Alternatively you can use Musiclib instead of MusiclibS.