Skip to main content

Download your Spotify playlists and songs along with album art and metadata

Project description

spotDL v4

spotDL finds songs from Spotify playlists on YouTube and downloads them - along with album art, lyrics and metadata.

MIT License PyPI version PyPi downloads Contributors Discord

spotDL: The fastest, easiest and most accurate command-line music downloader.


Read the documentation on ReadTheDocs!


Installation

Refer to our Installation Guide for more details.

Python (Recommended Method)

  • spotDL can be installed by running pip install spotdl.

On some systems you might have to change pip to pip3.

Other options
  • Prebuilt executable

  • On Termux

    • curl -L https://raw.githubusercontent.com/spotDL/spotify-downloader/master/scripts/termux.sh | sh
  • Arch

  • Docker

    • Build image:

      docker build -t spotdl .
      
    • Launch container with spotDL parameters (see section below). You need to create mapped volume to access song files

      docker run --rm -v $(pwd):/music spotdl download [trackUrl]
      
  • Build from source

    git clone https://github.com/spotDL/spotify-downloader && cd spotify-downloader
    pip install poetry
    poetry install
    python3 scripts/build.py
    

    An executable is created in spotify-downloader/dist/.

Installing FFmpeg

FFmpeg is required for spotDL. If using FFmpeg only for spotDL, you can simply install FFmpeg to your spotDL installation directory: spotdl --download-ffmpeg

We recommend the above option, but if you want to install FFmpeg system-wide, follow these instructions

  • Windows Tutorial
  • OSX - brew install ffmpeg
  • Linux - sudo apt install ffmpeg or use your distro's package manager

Usage

Using SpotDL without options::

spotdl [urls]

You can run spotDL as a package if running it as a script doesn't work:

python -m spotdl [urls]

General usage:

spotdl [operation] [options] QUERY

There are different operations spotDL can perform. The default is download, which simply downloads the songs from YouTube and embeds metadata.

The query for spotDL is usually a list of Spotify URLs, but for some operations like sync, only a single link or file is required. For a list of all options use spotdl -h

Supported operations
  • save: Saves only the metadata from Spotify without downloading anything.

    • Usage: spotdl save [query] --save-file {filename}.spotdl
  • web: Starts a web interface instead of using the command line. However, it has limited features and only supports downloading single songs.

  • url: Get direct download link for each song from the query.

    • Usage: spotdl web [query]
  • sync: Updates directories. Compares the directory with the current state of the playlist. Newly added songs will be downloaded and removed songs will be deleted. No other songs will be downloaded and no other files will be deleted.

    • Usage: spotdl sync [query] --save-file {filename}.spotdl

      This create a new sync file, to update the directory in the future, use:

      spotdl sync {filename}.spotdl

  • meta: Updates metadata for the provided song files.

Music Sourcing and Audio Quality

spotDL uses YouTube as a source for music downloads. This method is used to avoid any issues related to downloading music from Spotify.

Note Users are responsible for their actions and potential legal consequences. We do not support unauthorized downloading of copyrighted material and take no responsibility for user actions.

Audio Quality

spotDL downloads music from YouTube and is designed to always download the highest possible bitrate; which is 128 kbps for regular users and 256 kbps for YouTube Music premium users.

Check the Audio Formats page for more info.

Contributing

Interested in contributing? Check out our CONTRIBUTING.md to find resources around contributing along with a guide on how to set up a development environment.

Donate

help support the development and maintenance of the software ❤️

paypal kofi

License

This project is Licensed under the MIT License.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spotdl-4.1.8.tar.gz (80.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spotdl-4.1.8-py3-none-any.whl (99.7 kB view details)

Uploaded Python 3

File details

Details for the file spotdl-4.1.8.tar.gz.

File metadata

  • Download URL: spotdl-4.1.8.tar.gz
  • Upload date:
  • Size: 80.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for spotdl-4.1.8.tar.gz
Algorithm Hash digest
SHA256 bbc7008388d72438069592e6dbfe92f85255fffd1384136bea22408a28c46c9a
MD5 e02993becd23fd041bd93166fbadc9d3
BLAKE2b-256 deeffdb06966e85adf268cd98e2c5a532cc7feabcd553515ae2385c3d01cc545

See more details on using hashes here.

File details

Details for the file spotdl-4.1.8-py3-none-any.whl.

File metadata

  • Download URL: spotdl-4.1.8-py3-none-any.whl
  • Upload date:
  • Size: 99.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for spotdl-4.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 324abfe89e3cfb97112449712a037503891c8624f11ddac246f5c58291570dea
MD5 1f71862d423887670124295df572e84e
BLAKE2b-256 20ded7a102e6f27312ffa6395cd1f80e6fb4175fcdd9e7a3aaa9370c0bba133e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page