Skip to main content

Fox for rockbox. 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.
  • To update spotDL run pip install --upgrade 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
    poetry run 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 url [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.

Join our amazing community as a code contributor, and help accelerate



Donate

help support the development and maintenance of the software ❤️

paypal kofi

License

This project is Licensed under the MIT License.

Project details


Download files

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

Source Distribution

spotdl_rockbox-4.2.5.tar.gz (90.5 kB view details)

Uploaded Source

Built Distribution

spotdl_rockbox-4.2.5-py3-none-any.whl (114.0 kB view details)

Uploaded Python 3

File details

Details for the file spotdl_rockbox-4.2.5.tar.gz.

File metadata

  • Download URL: spotdl_rockbox-4.2.5.tar.gz
  • Upload date:
  • Size: 90.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.11

File hashes

Hashes for spotdl_rockbox-4.2.5.tar.gz
Algorithm Hash digest
SHA256 a47fe644e211e35786721cdc898eadc487dca22c39e8016969b61baf0cf02cf2
MD5 960eda00ed9984021ab2d8cc04e4efa5
BLAKE2b-256 d5eda8ecf99cd04c42fbc333d48e85412666848b895245e87235d463ad5cb044

See more details on using hashes here.

File details

Details for the file spotdl_rockbox-4.2.5-py3-none-any.whl.

File metadata

File hashes

Hashes for spotdl_rockbox-4.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0ba272b24ee3b5ba16b5611e15410c621cdabf9c7dc4d619bab113342ca626da
MD5 60b8dabb1081f72e18861517d80ec8fa
BLAKE2b-256 b84b4d05bc7a5987c205cc0f79bf54b009188de5ab12ed81e9f71ce7dc2a21f4

See more details on using hashes here.

Supported by

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