Skip to content

README.md

Latest commit

 

History

History
125 lines (92 loc) · 5.11 KB

README.md

File metadata and controls

125 lines (92 loc) · 5.11 KB

exportify-cli

exportify-cli

Export Spotify playlists to CSV or JSON directly from the terminal, inspired by pavelkomarov/exportify.

This tool can export all saved playlists, including liked songs.

Installation:

You can also download a binary from the releases page and skip steps 1 and 2. It's recommended to place it in a dedicated folder since it will create .cache, a config file and playlists folders.

  1. Clone this repository:
git clone https://github.com/donmerendolo/exportify-cli.git
  1. Install the required packages:
cd exportify-cli
uv sync
  1. Set up Client ID, a Redirect URI and a refresh token:

The first time you run exportify-cli, it will guide you through the setup:

File "config.cfg" not found or invalid. Let's create it.
Use a Client ID and Redirect URI that belong to the same Spotify app.

Spotify Client ID: 
Redirect URI:

If no valid .cache token is found, exportify-cli asks for a refresh_token once to bootstrap authentication. Spotipy then manages and refreshes tokens automatically using the .cache file, so you won't have to enter it again unless you log out or revoke access:

No valid Spotify token cache found. Enter your refresh token.
Spotify refresh token:

If you wish to log out, run:

python exportify-cli.py --logout

You may also revoke access in https://www.spotify.com/us/account/apps/.

Usage:

Usage: exportify-cli.py (-a | -p NAME|ID|URL|URI [-p ...] | -u ID|URL|URI | -l
| --logout) [OPTIONS]

  Export Spotify playlists to CSV or JSON.

Options:
    -a, --all                     Export all playlists
    -p, --playlist NAME|ID|URL|URI
                                  Export a Spotify playlist given name, ID,
                                  URL, or URI; repeatable.
    -u, --user ID|URL|URI         Export all public playlists of a Spotify
                                  user given ID, URL, or URI; repeatable.
    -l, --list                    List available playlists.
    --logout                      Delete cached Spotify auth token and exit.
    -c, --config PATH             Path to configuration file (default is
                                  ./config.cfg next to this script).
    -o, --output PATH             Directory to save exported files (default is
                                  ./playlists).
    -f, --format [csv|json]       Output file format (defaults to 'csv');
                                  repeatable.
    --uris                        Include album and artist URIs.
    --external-ids                Include track ISRC and album UPC.
    --no-bar                      Hide progress bar.
    --sort-key TEXT               Key to sort tracks by (default is
                                  'spotify_default').
    --reverse                     Reverse the sort order.
  -h, --help                      Show this message and exit.
  -v, --version                   Show the version and exit.
  • Default values can be changed in config.cfg.
  • Playlist names support partial matching, provided they uniquely identify a single playlist.
  • You can also export a playlist that's not saved in your library by using its ID, URL, or URI.
  • A single command can export multiple playlists by using the -p option multiple times. Same applies for the -u option.
  • You can export all public playlists of any user by using the -u option with their user ID, URL, or URI. It won't save Liked Songs from that user, as it's private.
  • The default fields are: Position, Track URI, Track Name, Album Name, Artist Name(s), Release Date, Duration_ms, Popularity, Added By, Added At, Record Label. With flags, Album URI(s), Artist URI(s), Track ISRC and Album UPC can be included too. If you want any other field to be added, feel free to open an issue or PR.

Examples:

# List all saved playlists
python exportify-cli.py --list

# Export all saved playlists, including liked songs with Artist and Album URIs
exportify-cli.exe --all --uris

# Export playlist whose name is "COCHE" to JSON in reverse order
python exportify-cli.py -p COCHE -f json --reverse

# Export playlist whose ID is "2VqAIceMCzBRhzq6zVmDZw" to current directory, sorted by Added At
exportify-cli.exe -p 2VqAIceMCzBRhzq6zVmDZw --output . --sort-key "Added At"

# Export playlist with its URL to both JSON and CSV
exportify-cli.exe -f json -f csv -p https://open.spotify.com/playlist/2VqAIceMCzBRhzq6zVmDZw?si=16df8ae16c2d492b

# Export playlists "Instrumental" and "COCHE" to CSV without progress bar, sorted by Popularity
python exportify-cli.py -p instr -p COCHE -f csv --no-bar --sort-key "popularity"

# Export all public playlists of user with ID "spotifyuser123" and user with URL "https://open.spotify.com/user/anotheruser456"
python exportify-cli.py -u spotifyuser123 -u https://open.spotify.com/user/anotheruser456

Building:

You can use PyInstaller to build a binary with this command:

pyinstaller --onefile .\exportify-cli.py