Spotify Library Manager

Originally derived as a fork of glomatico/spotify-aac-downloader, this has grown into a completely different behemoth.

This started as a simple want to mass-download songs for specific artists since they were not otherwise available, and snowballed into a full-fledged library management platform including:

• Task queuing system, allowing downloads to continue after restarts*
  • *Semi-lossy, where jobs which are interrupted will not be recovered, but any un-started jobs will be. Jobs can safely be restarted manually, though.
• Artist discography syncing and mass-downloading
• Artist tracking - auto downloading missing releases (including new)
• Fetch metadata for all albums available for tracked artists
• Mark un-downloaded albums as non-wanted
  • Useful for artists which have a large backlog of music you don't want, but you still want to track their latest stuff automatically
• Download all "wanted" albums (via queued tasks)
• Download playlists/albums directly
  • Can choose to auto mark all artists on given playlists as "Tracked", useful for "favourites" playlists
• Tracked playlist syncing
• Can continuously refresh and sync (every 4 hours)
• Can include auto-tracking new artists (such as tracking a "favourites" playlist)
• Artist tracking supporting auto-downloading newly released albums (including tracks)
• Can continuously refresh and sync (every 6 hours)
• Will download missing releases (every 6 hours, offset by 45 minutes)

Features from spotify-aac-downloader:

• Download songs in 128kbps AAC or 256kbps AAC with a premium account
• Download synced lyrics
• Includes a device wvd so no need to load your own!

Notes

While this has a lot of opportunity to improve, it's reached a "stable" state for my personal usage. Therefore I will fix critical issues as I encounter them, but will not actively be working on additional features except when inspiration hits me, or there are specific community requests.

If there is enough desire from folks, I am happy to put more time in, and of course always welcome Pull Requests!

TODO

Features To Add:

• Fallback to yt-dlp when no Spotify AAC
• Tracked Playlists
  • Improve update experience (not URL-locked)
• Allow periodic tasks to be configurable intervals
• Add artists directly (by artist name?)

Other Changes:

• Re-add Downloader configuration(s) loading via settings.yaml
• Improve onboarding documentation
  • Add critical steps such as first startup, any missing examples, etc

Screenshots

Configuration / Usage

It's currently being designed to mostly run on Linux-based systems, however, many of the configurations should only require minor tweaks to adjust for Windows-based systems.

Existing settings (that are applicable) are now set via /config/settings.yaml, and will override any default configurations. They must follow the format:

default:
    final_path: "/mnt/music_spotify"

Running From Docker (recommended)

An example docker-compose file is included in this repo that can be dropped into Portainer or your flavour of running it, swapping out any mounts for your local directory structure

1. Export your cookies using this Google Chrome extension on the Spotify website: https://chrome.google.com/webstore/detail/open-cookiestxt/gdocmgbfkjnnpapoeobnolbbkoibbcif
   • Make sure to be logged in
   • Save it as cookies.txt
2. // TODO - Execute docker container, mapping /config to the local directory with your cookies.txt, device.wvd, and settings.yml

Running From Source (not recommended unless developing)

Warning

While this is not recommended unless you are developing, this should work just fine.

Note

This is currently only configured for running on Unix-based systems due to the default configuration folder, but if anyone wants to update this doc with the correct configuration I'd welcome the upload!

If developing on Windows, using WSL should work just fine, installing python, ffmpeg, and aria2c via apt

1. Install Python 3.7 or higher

2. Add FFmpeg to PATH

   • Older versions of FFmpeg may not work

3. Place your cookies in /config/ as cookies.txt

   • You can export your cookies by using this Google Chrome extension on Spotify website: https://chrome.google.com/webstore/detail/open-cookiestxt/gdocmgbfkjnnpapoeobnolbbkoibbcif. Make sure to be logged in.

4. Install spotify-aac-downloader using pip

   pip install spotify-aac-downloader

5. (Optional) I personally like setting huey into instant-run mode so as to not have a separate worker, but if you are using this for non-development I would advise against this due to degraded performance! This should be placed in /config/ as settings.yaml

default:
  final_path: "/mnt/h/music_spotify"
  HUEY: {
    immediate: true,
    immediate_use_memory: true,
  }

7. Execute it using

bash -c "python manage.py migrate && python manage.py runserver 0.0.0.0:5000"

Extracting A Manual WVD

While the wvd that's hard-coded into this project should work, you can still extract the native one from your device via the following instructions:

• To get a .wvd file, you can use dumper to dump a L3 CDM from an Android device. Once you have the L3 CDM, use pywidevine to create the .wvd file from it.

1. Install pywidevine with pip bash pip install pywidevine pyyaml
2. Create the .wvd file bash pywidevine create-device -t ANDROID -l 3 -k private_key.pem -c client_id.bin -o .

Note

This needs to be polished and likely will not work until the below Configuration section is merged into the settings.yaml, but should not impede the ability to use this.

Place your .wvd file in /config/ as device.wvd, and specify this in the configuration

Configuration (IGNORE)

Caution

TO BE MIGRATED TO settings.yaml -- THESE WILL CHANGE NOTHING PRESENTLY

spotify-aac-downloader can be configured using the command line arguments or the config file. The config file is created automatically when you run spotify-aac-downloader for the first time at ~/.spotify-aac-downloader/config.json on Linux and %USERPROFILE%\.spotify-aac-downloader\config.json on Windows. Config file values can be overridden using command line arguments.

Command line argument / Config file key	Description	Default value
-f, --final-path / final_path	Path where the downloaded files will be saved.	./Spotify
-t, --temp-path / temp_path	Path where the temporary files will be saved.	./temp
-c, --cookies-location / cookies_location	Location of the cookies file.	./cookies.txt
-w, --wvd-location / wvd_location	Location of the .wvd file.	null
--config-location / -	Location of the config file.	<home_folder>/.spotify-aac-downloader/config.json
--ffmpeg-location / ffmpeg_location	Location of the FFmpeg binary.	ffmpeg
--aria2c-location / aria2c_location	Location of the aria2c binary.	aria2c
--template-folder-album / template_folder_album	Template of the album folders as a format string.	{album_artist}/{album}
--template-folder-compilation / template_folder_compilation	Template of the compilation album folders as a format string.	Compilations/{album}
--template-file-single-disc / template_file_single_disc	Template of the song files for single-disc albums as a format string.	{track:02d} {title}
--template-file-multi-disc / template_file_multi_disc	Template of the song files for multi-disc albums as a format string.	{disc}-{track:02d} {title}
--download-mode / download_mode	Download mode.	ytdlp
-e, --exclude-tags / exclude_tags	List of tags to exclude from file tagging separated by commas.	null
--truncate / truncate	Maximum length of the file/folder names.	40
-l, --log-level / log_level	Log level.	INFO
-p, --premium-quality / premium_quality	Download in 256kbps AAC instead of 128kbps AAC.	false
-l, --lrc-only / lrc_only	Download only the synced lyrics.	false
-n, --no-lrc / no_lrc	Don't download the synced lyrics.	false
-s, --save-cover / save_cover	Save cover as a separate file.	false
-o, --overwrite / overwrite	Overwrite existing files.	false
--print-exceptions / print_exceptions	Print exceptions.	false
-u, --url-txt / -	Read URLs as location of text files containing URLs.	false
-n, --no-config-file / -	Don't use 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
• comment
• compilation
• copyright
• cover
• disc
• disc_total
• isrc
• label
• lyrics
• media_type
• rating
• release_date
• title
• track
• track_total

Download mode

Note

If using the docker image, both ytdlp and aria2c will work by default.

The following download modes are available:

• ytdlp
• aria2c
  • Faster than ytdlp
  • Can be obtained from here: https://github.com/aria2/aria2/releases