PlaylistGrabber

A set of Python scripts that takes a YouTube playlist link of songs, downloads them, and embeds their metadata.

Getting Started

NOTE: You must have Python3 and pip already installed before following these steps.

WARNING: MacOS devices may require different set up steps (I am unable to test since I do not own a Mac)

1. Download .zip
2. Extract it to your desired path
3. Open your OS's terminal or the terminal inside IDE of choice
4. cd into PlaylistGrabber folder
5. run "pip install -r requirements.txt"
6. run "python -m main"

You are now all set up!

⭐ NOTE ⭐

On your first attempt to download anything, you will receive a message saying:

• "Please open [ Google device link ] and input code ###-###-####".

Authorizing an account is necessary to install songs using the pytube library.

If you desire to download songs marked as explicit by YouTube, you must log in to an account with age restrictions turned off. Otherwise, explicit songs will be skipped by the downloader.

Methods of Input

There are two ways to input YouTube playlist URLs and both may be useful in different scenarios.

1. Input each URL individually
2. Read the URLs stored in a .txt file

By default, songs in playlists with mostly full metadata (artist and album) are downloaded to a path that follows the format of "content/songs/Artist Name/Album Name/". However, this varies depending on what metadata is available under the video. If no artist's name is found, it substitutes with the video uploader's name instead. If no album name is found, there is no alternative data to work with, so it instead gets placed into a "UNORGANIZED" folder under the artist's (or uploader's) name.

Of course, these paths can be overridden; however, the process of overriding depends on whether Method 1 or 2 is being used.

Method 1: Inputting each URL individually

Output paths can be overridden by changing the settings of the following constants in main.py:

NOTE: Keeping AUTO_SORT_SONGS as True while using custom data will place songs in "content/songs/Custom Artist Name/Custom Album Name/".

• AUTO_SORT_SONGS = (Default = True)
  • Turning this off will result in your desired output path being asked after inputting each URL.
• USE_CUSTOM_ARTIST = (Default = False)
  • Asks for an additional input after URL input that overwrites any artist or uploader names that are found.
• USE_CUSTOM_ALBUM = (Default = False)
  • Asks for an additional input after URL input that overwrites any album names that are found.

Method 2: Reading from .txt

Reading from a text file makes downloading playlists a repeatable and streamlined process.

Much like Method 1, reading from a text file has custom keywords that can be used to override the artist's name, album, and output path by placing ARTIST[Desired Name], ALBUM[Desired Name], or PATH[File Path] in the line above the playlist's URL.

Additionally, END can be written on a separate line to end the downloading process at that line.

You can check "content/artists/" for some examples. The lines starting with '#' are comments for myself. You can also write comments without the hashtag, but I prefer to leave it for personal styling.

NOTE: The custom keywords do not need to be separated by "::". This is another personal styling preference. As long as the keyword is fully capitalized and the input is surrounded in square brackets, the custom data will be applied.

Additional Settings

Further changes can be made to how the songs themselves are downloaded. Changing these settings alters the downloads regardless of the method used to install the songs.

Universal Settings:

• SET_TRACK_NUMBERS (Default = True)
  • Writes spot of the downloaded song in playlist as track number in metadata.
• SET_NUM_IN_FILENAME = (Default = True)
  • Writes the song's track number in its filename (Example: 01 Song Name.mp3).
• SET_COVER_ART = (Default = True)
  • If cover art is provided in the song's YouTube description, embeds it as the song's cover image.
  • NOTE: If no cover source is found, it will instead embed this silly cat I drew.
    • If you wish to use a different default image, change the URL of DEFAULT_COVER_SOURCE in data_handler.py (Recommended to be 512x512 pixels).
    • Alternatively, if you desire songs with no found cover to be left blank, set DEFAULT_COVER_SOURCE in data_handler.py to None.