Skip to main content

Download Spotify tracks/albums with metadata via YouTube Music (Perfect for Jellyfin libraries!)

Project description

SpotifySaver 🎵✨

Python PyPI Version FFmpeg yt-dlp YouTube Music Spotify License: MIT Code style: black Ask DeepWiki

⚠️This repository is under a strong stage of development, expect constant changes. If you find any mistake or bug, please open an ISSUE.

All-in-one tool for downloading and organizing music with Spotify metadata for Jellyfin.

The app connects to the Spotify and YouTube Music APIs. The goal is to generate an .nfo XML file to complete the metadata required by Jellyfin when building music libraries.

Read this file in Spanish

🌟 Features

  • ✅ Download audio from YouTube Music with Spotify metadata
  • ✅ Synchronized lyrics (.lrc) from LRC Lib
  • ✅ Generation of Jellyfin-compatible .info files (Still some things to work on here! ⚠️)
  • ✅ Automatic folder structure (Artist/Album)
  • ✅ Command-line interface (CLI)
  • ✅ Playlist support
  • ✅ API
  • ✅ MP3 Conversion
  • ✅ Support for multiple bitrates (128, 180, 220, etc.)

Requirements

# Installation with Poetry (recommended)
git clone https://github.com/gabrielbaute/spotify-saver.git
cd spotify-saver
poetry install

# Or with pip
pip install git+https://github.com/gabrielbaute/spotify-saver.git

⚠️ IMPORTANT: You must log in to your Spotify account as a developer, create an app, and obtain a "client id" and "client secret." You must place this information in an .env file in the project's root directory.

⚙️ Configuration

Once in your project directory, run:

spotifysaver init

This will create a local .env file with the environment variables that will be requested:

Variable Description Default Value
SPOTIFY_CLIENT_ID ID of the Spotify app you created -
SPOTIFY_CLIENT_SECRET Secret key generated for your Spotify app -
SPOTIFY_REDIRECT_URI Spotify API Validation URI http://localhost:8888/callback
SPOTIFYSAVER_OUTPUT_DIR Custom directory path (optional) ./Music
YTDLP_COOKIES_PATH Cookie file path (optional) -
API_PORT API server port (optional) 8000
API_HOST Host for the API (optional) 0.0.0.0

The variable YTDLP_COOKIES_PATH will indicate the location of the file with the Youtube Music cookies, in case we have problems with restrictions to yt-dlp, specifically it is for cases in which youtube blocks the app for "behaving like a bot" (which is not entirely false lol)

You can also check the .example.env file

📚 Documentation

We maintain a documentation with Deepwiki, which constantly tree the repository. You can consult it at all times.

The documentation for using the API, on the other hand, can be found in this same repository here: API Documentation

💻 Using the CLI

Available Commands

Command Description Example
init Configure environment variables spotifysaver init"
download [URL] Download track/album from Spotify spotifysaver download "URL_SPOTIFY"
inspect Shows Spotify metadata (album, playlist) spotifysaver inspect "URL_SPOTIFY"
show-log Shows the application log spotifysaver show-log
version Shows the installed version spotifysaver version

Download Options

Option Description Accepted Values ​​
--lyrics Download synchronized lyrics (.lrc) Flag (no value)
--output DIR Output directory Valid path
--format FORMAT Audio format m4a (default), mp3
--cover Saves the cover album in de directoy (.jpg) Flag (no value)
--nfo Generates a .nfo metadata file in the JellyFin format Flag (no value)

show-log Options

Option Description Accepted Values ​​
--lines Number of log lines to display --lines 25 --> int
--level Filter by log level INFO, WARNING, DEBUG, ERROR
--path Displays the location of the log file Flag (no value)

💡 Usage Examples

# Set spotifysaver configuration
spotifysaver init

# Download album with synchronized lyrics
spotifysaver download "https://open.spotify.com/album/..." --lyrics

# Download album with album cover and metadata file
spotifysaver download "https://open.spotify.com/album/..." --nfo --cover

# Download song in MP3 format
spotifysaver download "https://open.spotify.com/track/..." --format mp3

Usage with API

To use the API, you need to have the API server running. You can start it with the following command:

# Start the API server
spotifysaver-api

The server will run at http://localhost:8000 by default. You can find the API documentation here, which describes the technical aspects and usage in detail.

📂 Output Structure

Music/
├── Artist/
│ ├── Album (Year)/
│ │ ├── 01 - Song.m4a
│ │ ├── 01 - Song.lrc
│ │ ├── album.nfo
│ │ └── cover.jpg
│ └── artist_info.nfo

🤝 Contributions

  1. Fork the project
  2. Create your branch (git checkout -b feature/new-feature)
  3. Commit your changes (git commit -m 'Add awesome feature')
  4. Push to the branch (git push origin feature/new-feature)
  5. Open a Pull Request

📄 License

MIT © TGabriel Baute

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

spotifysaver-0.5.2.tar.gz (39.2 kB view details)

Uploaded Source

Built Distribution

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

spotifysaver-0.5.2-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

Details for the file spotifysaver-0.5.2.tar.gz.

File metadata

  • Download URL: spotifysaver-0.5.2.tar.gz
  • Upload date:
  • Size: 39.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for spotifysaver-0.5.2.tar.gz
Algorithm Hash digest
SHA256 809e54f8831ee40405acaab4f3013a3af54d69bc85be387e985797f8b58cca76
MD5 d7951ecfaa69db652e1b3352ee5c977f
BLAKE2b-256 a0ee90c3e10d74b5f2c731c64360347356e1f9e196fa606c649c913f7c1423e9

See more details on using hashes here.

File details

Details for the file spotifysaver-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: spotifysaver-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 57.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.0

File hashes

Hashes for spotifysaver-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 75fbb07884739af89f023e343ef0117a9a1e07c4847846d80830737e5f8eedf5
MD5 a1418d430c0f7326c7eb39277eb9c219
BLAKE2b-256 5a214ccd440f6a92bbfeff1c1f410da9f5ad388ef1007f26bd25504527385c2a

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