lanesh4d0w / spotify-ripper

Version 2.9.6 - Rip songs from Spotify using Terminal(Linux, MacOS, WSL 1 & 2) - Supports pyspotify 2.1.3 - Cover art works too

A fork of spotify-ripper that uses pyspotify v2.1.3

Spotify Ripper is a small ripper script for Spotify that rips Spotify URIs to audio files and includes ID3 tags and cover art. By default spotify-ripper will encode to MP3 files, but includes the ability to rip to WAV, FLAC, Ogg Vorbis, Opus, AAC, and MP4/M4A.

Spotify Ripper is not affliated with Spotify in any way

Stream ripping violates the libspotify's ToS

Spotify recently changed how their desktop app works. It no longer shows a URI for albums or tracks, but instead it shows album / track url links. Spotify Ripper will still work but it takes some different steps.

How to convert album / track url links to URI:

Track: https://open.spotify.com/track/3tQ6LmYZeoJ4dwkZ3IGoSj?si=9e7b8b1d2bd1481f = spotify:track:3tQ6LmYZeoJ4dwkZ3IGoSj
Album: https://open.spotify.com/album/3zuIMH8P0GKtV5LR6zwGLB?si=v_PvykSQTxOJXpLP3eIpEQ = spotify:album:3zuIMH8P0GKtV5LR6zwGLB

Help Wanted: If anyone can figure out how to make a link like this: "https://open.spotify.com/track/3tQ6LmYZeoJ4dwkZ3IGoSj?si=9e7b8b1d2bd1481f" work instead of using "spotify:track:3tQ6LmYZeoJ4dwkZ3IGoSj", please fork this repo, implement the changes, and send me a PR. If I like what I see, then I can add it on here as a future version. I'll also add you as a contributor of this project.

Libspotify’s Deprecation

From Mopidy's documentation

As of May 2015 libspotify is officially deprecated by Spotify and is no longer actively maintained.

Also, as of Jan 2016, Spotify may no longer be issuing developer keys.

Spotify has published newer libraries intended for Android and iOS development, as well as web APIs to access track metadata and manage playlists. Though, for making apps with Spotify playback capabilities, on any other platform than Android and iOS, there is currently no alternative to libspotify.

Libspotify has been the main way of integrating with Spotify since 2009, and is today a part of numerous open source projects and commercial applications, including many receivers and even cars. There’s no guarantees, but one can hope that the large deployment of libspotify means that the library will continue to work with the Spotify service for a long time into the future.

Features

• Real-time VBR or CBR ripping from Spotify PCM stream
• Writes ID3v2/metadata tags (including album covers)
• Rips files into the following directory structure: artist/album/artist - song.mp3 by default or optionally into a user-specified structure (see Format String section below)
• Option to skip or overwrite existing files
• Accepts tracks, playlists, albums, and artist URIs
• Search for tracks using Spotify queries
• Options for interactive login (no password in shell history) and to relogin using previous credentials
• Option to remove tracks from playlist after successful ripping
• Globally installs ripper script using setup.py
• Python 2.7.x and 3.4.x compatible. Python 3 will occasionally throw a NameError: name '_lock' is not defined exception at the end of the script due to an upstream bug in pyspotify.
• Use a config file to specify common command-line options
• Helpful progress bar to gauge the time remaining until completion
• Keep local files in sync with a Spotify playlist, m3u and wpl playlist file
• Option to rip to ALAC, a loseless codec, instead of MP3 (requires extra avconv dependency)
• Option to rip to FLAC, a loseless codec, instead of MP3 (requires extra flac dependency)
• Option to rip to Ogg Vorbis instead of MP3 (requires extra vorbis-tools dependency)
• Option to rip to Opus instead of MP3 (requires extra opus-tools dependency)
• Option to rip to AAC instead of MP3 (requires extra faac dependency)
• Option to rip to MP4/M4A instead of MP3 (requires compiling fdkaac)
• Option to replace output filenames
• Option to normalize output filenames to NFKD (see Normalization)

Ripping playlists require putting Spotify URIs into a .txt file and using the command spotify-ripper name_of_file.txt.

Spotify’s highest quality setting is 320 kbps, so the benefit of ripping to a lossless format is to not double encode the audio data. It’s not possible to rip in true lossless quality.

Usage

spotify-ripper takes many command-line options

usage: spotify-ripper [-h] [-S SETTINGS] [-a] [--aac] [--alac]
                      [--artist-album-type ARTIST_ALBUM_TYPE]
                      [--artist-album-market ARTIST_ALBUM_MARKET] [-A]
                      [-b BITRATE] [-c] [--comp COMP] [--comment COMMENT]
                      [--cover-file COVER_FILE]
                      [--cover-file-and-embed COVER_FILE] [-d DIRECTORY]
                      [--fail-log FAIL_LOG] [--flac] [-f FORMAT]
                      [--format-case {upper,lower,capitalize}] [--flat]
                      [--flat-with-index] [-g {artist,album}]
                      [--grouping GROUPING] [--id3-v23] [-k KEY] [-u USER]
                      [-p PASSWORD] [-l] [-L LOG] [--pcm] [--mp4]
                      [--normalize] [-na] [-o] [--opus]
                      [--partial-check {none,weak,strict}]
                      [--play-token-resume RESUME_AFTER] [--playlist-m3u]
                      [--playlist-wpl] [--playlist-sync] [-q VBR]
                      [-Q {160,320,96}] [--remove-offline-cache]
                      [--resume-after RESUME_AFTER] [-R REPLACE [REPLACE ...]]
                      [-s] [--stereo-mode {j,s,f,d,m,l,r}]
                      [--stop-after STOP_AFTER] [-V] [--wav] [--vorbis] [-r]
                      uri [uri ...]

Rips Spotify URIs to MP3s with ID3 tags and album covers

positional arguments:
  uri                   One or more Spotify URI(s) (either URI, a file of URIs or a search query)

optional arguments:
  -h, --help            show this help message and exit
  -S SETTINGS, --settings SETTINGS
                        Path to settings, config and temp files directory [Default=~/.spotify-ripper]
  -a, --ascii           Convert the file name and the metadata tags to ASCII encoding [Default=utf-8]
  --aac                 Rip songs to AAC format with FreeAAC instead of MP3
  --alac                Rip songs to Apple Lossless format instead of MP3
  --artist-album-type ARTIST_ALBUM_TYPE
                        Only load albums of specified types when passing a Spotify artist URI [Default=album,single,ep,compilation,appears_on]
  --artist-album-market ARTIST_ALBUM_MARKET
                        Only load albums with the specified ISO2 country code when passing a Spotify artist URI. You may get duplicate albums if not set. [Default=any]
  -A, --ascii-path-only
                        Convert the file name (but not the metadata tags) to ASCII encoding [Default=utf-8]
  -b BITRATE, --bitrate BITRATE
                        CBR bitrate [Default=320]
  -c, --cbr             CBR encoding [Default=VBR]
  --comp COMP           compression complexity for FLAC and Opus [Default=Max]
  --comment COMMENT     Set comment metadata tag to all songs. Can include same tags as --format.
  --cover-file COVER_FILE
                        Save album cover image to file name (e.g "cover.jpg") [Default=embed]
  --cover-file-and-embed COVER_FILE
                        Same as --cover-file but embeds the cover image too
  -d DIRECTORY, --directory DIRECTORY
                        Base directory where ripped MP3s are saved [Default=cwd]
  --fail-log FAIL_LOG   Logs the list of track URIs that failed to rip
  --flac                Rip songs to lossless FLAC encoding instead of MP3
  -f FORMAT, --format FORMAT
                        Save songs using this path and filename structure (see README)
  --format-case {upper,lower,capitalize}
                        Convert all words of the file name to upper-case, lower-case, or capitalized
  --flat                Save all songs to a single directory (overrides --format option)
  --flat-with-index     Similar to --flat [-f] but includes the playlist index at the start of the song file
  -g {artist,album}, --genres {artist,album}
                        Attempt to retrieve genre information from Spotify's Web API [Default=skip]
  --grouping GROUPING   Set grouping metadata tag to all songs. Can include same tags as --format.
  --id3-v23             Store ID3 tags using version v2.3 [Default=v2.4]
  -k KEY, --key KEY     Path to Spotify application key file [Default=Settings Directory]
  -u USER, --user USER  Spotify username
  -p PASSWORD, --password PASSWORD
                        Spotify password [Default=ask interactively]
  -l, --last            Use last login credentials
  -L LOG, --log LOG     Log in a log-friendly format to a file (use - to log to stdout)
  --pcm                 Saves a .pcm file with the raw PCM data instead of MP3
  --mp4                 Rip songs to MP4/M4A format with Fraunhofer FDK AAC codec instead of MP3
  --normalize           Normalize volume levels of tracks
  -na, --normalized-ascii
                        Convert the file name to normalized ASCII with unicodedata.normalize (NFKD)
  -o, --overwrite       Overwrite existing MP3 files [Default=skip]
  --opus                Rip songs to Opus encoding instead of MP3
  --partial-check {none,weak,strict}
                        Check for and overwrite partially ripped files. "weak" will err on the side of not re-ripping the file if it is unsure, whereas "strict" will re-rip the file [Default=weak]
  --play-token-resume RESUME_AFTER
                        If the 'play token' is lost to a different device using the same Spotify account, the script will wait a specified amount of time before restarting. This argument takes the same values as --resume-after [Default=abort]
  --playlist-m3u        create a m3u file when ripping a playlist
  --playlist-wpl        create a wpl file when ripping a playlist
  --playlist-sync       Sync playlist songs (rename and remove old songs)
  -q VBR, --vbr VBR     VBR quality setting or target bitrate for Opus [Default=0]
  -Q {160,320,96}, --quality {160,320,96}
                        Spotify stream bitrate preference [Default=320]
  --remove-offline-cache
                        Remove libspotify's offline cache directory after the ripis complete to save disk space
  --resume-after RESUME_AFTER
                        Resumes script after a certain amount of time has passed after stopping (e.g. 1h30m). Alternatively, accepts a specific time in 24hr format to start after (e.g 03:30, 16:15). Requires --stop-after option to be set
  -R REPLACE [REPLACE ...], --replace REPLACE [REPLACE ...]
                        pattern to replace the output filename separated by "/". The following example replaces all spaces with "_" and all "-" with ".":    spotify-ripper --replace " /_" "\-/." uri
  -s, --strip-colors    Strip coloring from output [Default=colors]
  --stereo-mode {j,s,f,d,m,l,r}
                        Advanced stereo settings for Lame MP3 encoder only
  --stop-after STOP_AFTER
                        Stops script after a certain amount of time has passed (e.g. 1h30m). Alternatively, accepts a specific time in 24hr format to stop after (e.g 03:30, 16:15)
  -V, --version         show program's version number and exit
  --wav                 Rip songs to uncompressed WAV file instead of MP3
  --vorbis              Rip songs to Ogg Vorbis encoding instead of MP3
  -r, --remove-from-playlist
                        Delete tracks from playlist after successful ripping [Default=no]

Example usage:
    rip a single file: spotify-ripper -u user spotify:track:52xaypL0Kjzk0ngwv3oBPR
    rip entire playlist: spotify-ripper -u user spotify:user:username:playlist:4vkGNcsS8lRXj4q945NIA4
    rip a list of URIs: spotify-ripper -u user list_of_uris.txt
    rip tracks from Spotify's charts: spotify-ripper -l spotify:charts:regional:global:weekly:latest
    search for tracks to rip: spotify-ripper -l -Q 160 -o "album:Rumours track:'the chain'"

Facebook Login

Spotify Ripper will work with your regular Facebook login/password if you setup your Spotify account to login using your Facebook credentials. Otherwise, use your Spotify login/password.

Config File

For options that you want set on every run, you can use a config file named config.ini in the settings folder (defaults to ~/.spotify-ripper). The options in the config file use the same name as the command line options with the exception that dashes are translated to snake_case. Any option specified in the command line will overwrite any setting in the config file. Please put all options under a main section.

Here is an example config file

[main]
ascii = True
format = {album_artist}/{album}/{artist} - {track_name}.{ext}
quality = 160
vorbis = True
last = True

Format String

The format string dictates how spotify-ripper will organize your ripped files. This is controlled through the -f | --format option. The string should include the format of the file name and optionally a directory structure. If you do not include a format string, the default format will be used: {album_artist}/{album}/{artist} - {track_name}.{ext}.

The --flat option is shorthand for using the format string: {artist} - {track_name}.{ext}, and the --flat-with-index option is shorthand for using the format string: {idx:3} - {artist} - {track_name}.{ext}. The use of these shorthand options will override any --format string option given.

Your format string can include the following variables names, which are case-sensitive and wrapped in curly braces, if you want your file/path name to be overwritten with Spotify metadata.

Format String Variables

Names and Aliases	Description
{track_artist}, {artist}	The track's artist
{track_artists}, {artists}	Similar to {track_artist} but will be join multiple artists with a comma (e.g. "artist 1, artist 2")
{album_artist}	When passing an album, the album's artist (e.g. "Various Artists"). If no album artist exists, the track artist is used instead
{album_artists_web}	Similar to {album_artist} but retrieves artist information from Spotify's Web API. Unlike {album_artist}, multiple album artists can be retrieved and will be joined with a comma (e.g. "artist 1, artist 2")
{album}	Album name
{track_name}, {track}	Track name
{year}	Release year of the album
{ext}, {extension}	Filename extension (i.e. "mp3", "ogg", "flac", ...)
{idx}, {index}	Playlist index
{track_num}, {track_idx}, {track_index}	The track number of the disc
{disc_num}, {disc_idx}, {disc_index}	The disc number of the album
{smart_track_num}, {smart_track_idx}, {smart_track_index}	For a multi-disc album, {smart_track_num} will return a number combining the disc and track number. e.g. for disc 2, track 4 it will return "204". For a single disc album, it will return the track num.
{playlist}, {playlist_name}	Name of playlist if passed a playlist uri, otherwise "No Playlist"
{playlist_owner}, {playlist_user}, {playlist_username}	User name of playlist's owner if passed a a playlist uri, otherwise "No Playlist Owner"
{playlist_track_add_time}, {track_add_time}	When the track was added to the playlist
{playlist_track_add_user}, {track_add_user}	The user that added the track to the playlist
{user}, {username}	Spotify username of logged-in user
{feat_artists}, {featuring_artists}	Featuring artists join by commas (see Prefix String section below)
{copyright}	Album copyright message
{label}, {copyright_holder}	Album copyright message with the year removed at the start of the string if it exists

Any substring in the format string that does not match a variable above will be passed through to the file/path name unchanged.

Zero-Filled Padding

Format variables that represent an index can be padded with zeros to a user-specified length. For example, {idx:3} will produce the following output: 001, 002, 003, etc. If no number is provided, no zero-filled padding will occur (e.g. 8, 9, 10, 11, ...). The variables that accept this option include {idx}, {track_num}, {disc_num}, {smart_track_num} and their aliases.

Prefix String

Format variable feat_artists takes a prefix string to be prepended before the output. For example, {feat_artists:featuring} will produce the follow output featuing Bruno Mars. If there are no featuring artists, the prefix string (and any preceding spaces) will not be included.

Playlist Sync Option

By default, other than checking for an overwrite, spotify-ripper will not keep track of local files once they are ripped from Spotify. However, if you use the --playlist-sync option when passing a playlist URI, spotify-ripper will store a json file in your settings directory that keeps track of location of your ripped files for that playlist.

If at a later time, the playlist is changed on Spotify (i.e. songs reordered, removed or added), spotify-ripper will try to keep your local files "in sync" the playlist if you rerun the same command. For example, if your format string is {index} {artist} - {track_name}.{ext}, it will rename is existing files so the index is correct. Note that with option set, spotify-ripper will delete a song that was previously on the playlist, but was removed but still exists on your local machine. It does not affect files outside of the playlist and has no effect on non-playlist URIs.

If you want to redownload a playlist (for example with improved quality), you either need to remove the song files from your local or use the --overwrite option.

Installation

Prerequisites

• libspotify <--Download this for later use (MacOS).
• pyspotify
• a Spotify binary app key (spotify_appkey.key)
• lame
• mutagen
• colorama
• (optional) flac
• (optional) opus-tools
• (optional) vorbis-tools
• (optional) faac
• (optional) fdkaac

MacOS

Spotify Ripper works with macOS 11 Big Sur

The recommended approach uses homebrew and pyenv.

To install pyenv using homebrew:

brew update
brew install pyenv
eval "$(pyenv init -)"
## the next line ensures 'eval "$(pyenv init -)"' is run every time terminal is opened
echo 'if which pyenv > /dev/null; then eval "$(pyenv init -)"; fi' >> ~/.bash_profile
pyenv install 2.7.10 # or whatever version of python you want
pyenv global 2.7.10
python -V # should say Python 2.7.10

To install spotify-ripper once pyenv is setup:

Download libspotify 12.1.51 for Mac OS X/Darwin from the link above (Prerequisites)
Uncompress the file and copy libspotify.framework to /Library/Frameworks (optional)
sudo cp -R ./libspotify-12.1.51-Darwin-universal/libspotify.framework /Library/Frameworks
Create a symbolic link to /usr/local/opt/libspotify/lib/libspotify
sudo mkdir -p /usr/local/opt/libspotify/lib
sudo ln -s /Library/Frameworks/libspotify.framework/libspotify /usr/local/opt/libspotify/lib
brew install lame
Pyspotify will have to be installed using pip before you can run the command below
You will need pip for Python 2 since pip for Python 3 doesn't know how to install pyspotify.
To install pip for Python 2, just do this:
Type in 'curl https://bootstrap.pypa.io/pip/2.7/get-pip.py -o get-pip.py'
Then, type in 'sudo python get-pip.py' (Enter your password if instructed to)
See if pip installed by typing in 'pip'
Next, type in 'sudo pip install pyspotify' (Enter your password if instructed to)
Everything else should be installed properly using the command below
git clone https://github.com/richardk80/spotify-ripper.git && cd spotify-ripper && sudo python setup.py install
pyenv rehash

Spotify may no longer be issuing developer keys. See Libspotify’s Deprecation

Take the application key file spotify_appkey.key from this repo (requires a Spotify Premium Account) and move the file to the ~/.spotify-ripper directory (or use the -k | --key option).

Ubuntu / Debian

As of Ubuntu 20.04, Python 2 has been removed and Python 3 is the default. You can use the pyenv method to install Python 2 on Ubuntu 20.04 and up, but if that does not work you can follow this guide.

The recommended approach uses pyenv. If you don't use pyenv, you need to install the python-dev package also.

Follow these steps to install pip for Python 2.

1. Type in curl https://bootstrap.pypa.io/pip/2.7/get-pip.py -o get-pip.py

2. Type in sudo python get-pip.py or sudo python2 get-pip.py (Enter your password if instructed to)

3. See if pip is installed by typing in pip

4. Type in sudo pip install pyspotify (Enter your password if instructed to)

To install spotify-ripper on Raspberry Pi 4, you need to be running Ubuntu 18.04.6 to 21.10 and it should be the ARMHF version because the ARM64 version will not work at all.

Here are links to the actual distros you can use: 18.04.6 | 20.04.3 | 21.04 | 21.10

sudo apt-get install lame build-essential libffi-dev git python-dev python-setuptools
wget https://mopidy.github.io/libspotify-archive/libspotify-12.1.103-Linux-armv6-bcm2708hardfp-release.tar.gz
tar xvf libspotify-12.1.103-Linux-armv6-bcm2708hardfp-release.tar.gz
cd libspotify-12.1.103-Linux-armv6-bcm2708hardfp-release/
sudo make install prefix=/usr/local
git clone https://github.com/richardk80/spotify-ripper.git && cd spotify-ripper && sudo python setup.py install

The instructions above should work for any other types of Raspberry Pi's that will run either of these versions of Ubuntu.

Spotify-ripper can even be used with RetroPie by following the instructions above and then following some extra steps:

After spotify-ripper is installed, only the root user will be able to use it by default, but it can be fixed to be used by the pi user as well and this is how:

sudo su
cp -r /root/.spotify-ripper /home/pi/
chmod -R 777 /home/pi/.spotify-ripper
exit

Now you will need to add the config.ini and spotify_appkey.key files to the .spotify-ripper folder just like you normally would and then edit the config.ini file to fit your needs.

This has only been tested with a Raspberry Pi 4, so as with any other version of Raspberry Pi, your mileage may vary.

To install pyenv using pyenv-installer (requires git and curl):

curl -L https://raw.githubusercontent.com/yyuu/pyenv-installer/master/bin/pyenv-installer | bash
## restart terminal ##
pyenv install 2.7.10 # or whatever version of python you want
pyenv global 2.7.10
python -V # should say Python 2.7.10

To install spotify-ripper once pyenv is setup:

sudo apt-get install lame build-essential libffi-dev git python-dev python-setuptools
wget https://mopidy.github.io/libspotify-archive/libspotify-12.1.51-Linux-x86_64-release.tar.gz #(assuming 64-bit)
tar xvf libspotify-12.1.51-Linux-x86_64-release.tar.gz
cd libspotify-12.1.51-Linux-x86_64-release/
sudo make install prefix=/usr/local
git clone https://github.com/richardk80/spotify-ripper.git && cd spotify-ripper && sudo python setup.py install
pyenv rehash

Spotify may no longer be issuing developer keys. See Libspotify’s Deprecation

Take the application key file spotify_appkey.key from this repo (requires a Spotify Premium Account) and move the file to the ~/.spotify-ripper directory (or use the -k | --key option).

Windows(WSL 1 & 2)

Unfortunately, pyspotify seems to have an issue building on Windows (if someone can get this to work, please let me know). The best alternative is to set up WSL in Windows 10. Instructions on how to install WSL in Windows 10 can be found in this tutorial. You should use Ubuntu with WSL. After you've completed all installation steps, follow the Ubuntu/Debian install steps listed above.

There's a few extra steps when using WSL:

These steps should also be used after installing on both Ubuntu/Debian or MacOS.

1. After installation of spotify-ripper is complete, change the read/write permissions for the .spotify-ripper folder with:

sudo chmod -R 777 .spotify-ripper

2. Next, cd into your .spotify-ripper folder with:

cd .spotify-ripper

3. Add the config.ini and spotify_appkey.key files from this repo into the .spotify-ripper folder.

4. Adjust the config.ini file using the options above or just use the defaults.

Optional Encoding Formats

In addition to MP3 encoding, spotify-ripper supports encoding to FLAC, AAC, MP4/M4A, Ogg Vorbis and Opus. However, additional encoding tools need to be installed for each codec you wish to use.

MacOS

# FLAC
brew install flac

# ALAC
brew install libav --build-from-source

# AAC
brew install faac

# MP4/M4A
brew install fdk-aac-encoder

# Ogg Vorbis
brew install vorbis-tools

# Opus
brew install opus-tools

Ubuntu / Debian

If installing onto RetroPie, libav-tools, faac, and libfdk-aac-dev are not available through the official raspbian sources. These will have to be installed manually.

# FLAC
sudo apt install flac

# ALAC
sudo apt install libav-tools

# AAC
sudo apt install faac

# MP4/M4A (need to compile fdkaac from source)
sudo apt install libfdk-aac-dev automake autoconf
git clone https://github.com/nu774/fdkaac.git
cd fdkaac
autoreconf -i
./configure
sudo make install

# Ogg Vorbis
sudo apt install vorbis-tools

# Opus
sudo apt install opus-tools

To install libav-tools manually, follow these steps:
sudo apt install ffmpeg
wget http://security.ubuntu.com/ubuntu/pool/universe/f/ffmpeg/libav-tools_2.8.17-0ubuntu0.1_all.deb
sudo dpkg -i libav-tools_2.8.17-0ubuntu0.1_all.deb

To install faac manually, follow these steps:
wget http://ports.ubuntu.com/pool/multiverse/f/faac/libfaac0_1.28+cvs20151130-1_armhf.deb
sudo dpkg -i libfaac0_1.28+cvs20151130-1_armhf.deb
wget http://ports.ubuntu.com/pool/multiverse/f/faac/faac_1.28+cvs20151130-1_armhf.deb
sudo dpkg -i faac_1.28+cvs20151130-1_armhf.deb

To install libfdk-aac-dev manually, follow these steps:
wget http://ftp.us.debian.org/debian/pool/non-free/f/fdk-aac/libfdk-aac1_0.1.4-2+b1_armhf.deb
sudo dpkg -i libfdk-aac1_0.1.4-2+b1_armhf.deb
wget http://ftp.us.debian.org/debian/pool/non-free/f/fdk-aac/libfdk-aac-dev_0.1.4-2+b1_armhf.deb
sudo dpkg -i libfdk-aac-dev_0.1.4-2+b1_armhf.deb

If at any time there is an error about broken packages, just issue this command: sudo apt install --fix-broken.

Upgrade

Use git pull to upgrade to the latest version.

cd spotify-ripper
git pull

License

MIT License