Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glomatico/votify
A Python CLI app for downloading songs/podcasts from Spotify.
https://github.com/glomatico/votify
aac cli downloader music-video ogg ogg-vorbis python spotify spotify-downloader video vorbis
Last synced: 2 days ago
JSON representation
A Python CLI app for downloading songs/podcasts from Spotify.
- Host: GitHub
- URL: https://github.com/glomatico/votify
- Owner: glomatico
- License: mit
- Created: 2024-09-20T16:47:34.000Z (13 days ago)
- Default Branch: main
- Last Pushed: 2024-09-30T00:00:12.000Z (4 days ago)
- Last Synced: 2024-09-30T00:14:19.756Z (4 days ago)
- Topics: aac, cli, downloader, music-video, ogg, ogg-vorbis, python, spotify, spotify-downloader, video, vorbis
- Language: Python
- Homepage:
- Size: 166 KB
- Stars: 40
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Votify
A Python CLI app for downloading songs/podcasts/videos from Spotify.
**Discord Server:** https://discord.gg/aBjMEZ9tnq
## Features
* Download songs and podcasts in Vorbis or AAC
* Download podcast videos
* Download music videos with a premium account
* Support for artist links to download all of their albums
* Download synced lyrics
* Highly configurable
## Prerequisites
* Python 3.8 or higher
* The cookies file of your Spotify browser session in Netscape format (free or premium)
* To export your cookies, use one of the following browser extensions while signed in to Spotify:
* Firefox: https://addons.mozilla.org/addon/export-cookies-txt
* Chromium based browsers: https://chrome.google.com/webstore/detail/gdocmgbfkjnnpapoeobnolbbkoibbcif
### Optional dependencies
The following tools are optional but required for specific features. Add them to your system’s PATH or specify their paths using command-line arguments or the config file.
* [FFmpeg](https://ffmpeg.org/download.html)
* Used when setting `ffmpeg` as remux mode.
* Used when setting `mp4` or `webm` as video format.
* [MP4Box](https://gpac.io/downloads/gpac-nightly-builds/)
* Used when setting `mp4box` as remux mode.
* [Shaka Packager](https://github.com/shaka-project/shaka-packager/releases/latest)
* Used when setting `webm` as video format and when downloading music videos.
* [mp4decrypt](https://www.bento4.com/downloads/)
* Used when setting `mp4box` or `mp4decrypt` as remux mode.
* [aria2c](https://github.com/aria2/aria2/releases)
* Used when setting `aria2c` as download mode.
* .wvd file
* Used when setting `aac` as audio quality or when downloading music videos.
* A .wvd file contains the Widevine keys from a device and is required to decrypt music videos and songs in AAC. The easiest method of obtaining one is using KeyDive, which extracts it from an Android device. Detailed instructions can be found here: https://github.com/hyugogirubato/KeyDive.
* Note: .wvd files extracted from emulated devices may not work.
## Installation
1. Install the package `votify` using pip
```bash
pip install votify
```
2. Set up the cookies file.
* You can either move to the current directory from which you will be running Votify as `cookies.txt` or specify its path using the command-line arguments/config file.
## Usage
```bash
votify [OPTIONS] URLS...
```
### Examples
* Download a song
```bash
votify "https://open.spotify.com/track/18gqCQzqYb0zvurQPlRkpo"
```
* Download an album
```bash
votify "https://open.spotify.com/album/0r8D5N674HbTXlR3zNxeU1"
```
* Download a podcast episode
```bash
votify "https://open.spotify.com/episode/3kwxWnzGH8T6UY2Nq582zx"
```
* Download a podcast series
```bash
votify "https://open.spotify.com/show/4rOoJ6Egrf8K2IrywzwOMk"
* Download a music video
```bash
votify "https://open.spotify.com/track/31k4hgHmrbzorLZMvMWuzq" --enable-videos
```
* List and select a related music video to download from a song
```bash
votify "https://open.spotify.com/track/0a0n6u6j3t6m0p4k0t0k0u0" --enable-videos --download-music-videos
```
* Download a podcast video
```bash
votify "https://open.spotify.com/episode/3kwxWnzGH8T6UY2Nq582zx" --enable-videos --download-podcast-videos
```
* Choose which albums to download from an artist
```bash
votify "https://open.spotify.com/artist/0gxyHStUsqpMadRV0Di1Qt"
```
### Interactive prompt controls
* Arrow keys - Move selection
* Space - Toggle selection
* Ctrl + A - Select all
* Enter - Confirm selection
## Configuration
Votify can be configured using the command-line arguments or the config file.
The config file is created automatically when you run Votify for the first time at `~/.votify/config.json` on Linux and `%USERPROFILE%\.votify\config.json` on Windows.
Config file values can be overridden using command-line arguments.
| Command-line argument / Config file key | Description | Default value |
| --------------------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------------- |
| `--wait-interval`, `-w` / `wait_interval` | Wait interval between downloads in seconds. | `5` |
| `--enable-videos` / `enable_videos` | Enable video downloads when available. | `false` |
| `--download-music-videos` / `download_music_videos` | List and select a related music video to download from songs. | `false` |
| `--download-podcast-videos` / `download_podcast_videos` | Attempt to download the video version of podcasts. | `false` |
| `--force-premium`, `-f` / `force_premium` | Force to detect the account as premium. | `false` |
| `--read-urls-as-txt`, `-r` / - | Interpret URLs as paths to text files containing URLs. | `false` |
| `--config-path` / - | Path to config file. | `/.spotify-web-downloader/config.json` |
| `--log-level` / `log_level` | Log level. | `INFO` |
| `--no-exceptions` / `no_exceptions` | Don't print exceptions. | `false` |
| `--cookies-path` / `cookies_path` | Path to cookies file. | `cookies.txt` |
| `--output-path`, `-o` / `output_path` | Path to output directory. | `Spotify` |
| `--temp-path` / `temp_path` | Path to temporary directory. | `temp` |
| `--wvd-path` / `wvd_path` | Path to .wvd file. | `device.wvd` |
| `--aria2c-path` / `aria2c_path` | Path to aria2c binary. | `aria2c` |
| `--ffmpeg-path` / `ffmpeg_path` | Path to ffmpeg binary. | `ffmpeg` |
| `--mp4box-path` / `mp4box_path` | Path to MP4Box binary. | `mp4box` |
| `--mp4decrypt-path` / `mp4decrypt_path` | Path to mp4decrypt binary. | `mp4decrypt` |
| `--packager-path` / `packager_path` | Path to Shaka Packager binary. | `packager` |
| `--template-folder-album` / `template_folder_album` | Template folder for tracks that are part of an album. | `{album_artist}/{album}` |
| `--template-folder-compilation` / `template_folder_compilation` | Template folder for tracks that are part of a compilation album. | `Compilations/{album}` |
| `--template-file-single-disc` / `template_file_single_disc` | Template file for the tracks that are part of a single-disc album. | `{track:02d} {title}` |
| `--template-file-multi-disc` / `template_file_multi_disc` | Template file for the tracks that are part of a multi-disc album. | `{disc}-{track:02d} {title}` |
| `--template-folder-episode` / `template_folder_episode` | Template folder for episodes (podcasts). | `Podcasts/{album}` |
| `--template-file-episode` / `template_file_episode` | Template file for music videos. | `{track:02d} {title}` |
| `--template-folder-music-video` / `template_folder_music_video` | Template folder for music videos | `{artist}/Unknown Album` |
| `--template-file-music-video` / `template_file_music_video` | Template file for the tracks that are not part of an album. | `{title}` |
| `--template-file-playlist` / `template_file_playlist` | Template file for the M3U8 playlist. | `Playlists/{playlist_artist}/{playlist_title}` |
| `--date-tag-template` / `date_tag_template` | Date tag template. | `%Y-%m-%dT%H:%M:%SZ` |
| `--save-cover` / `save_cover` | Save cover as a separate file. | `false` |
| `--save-playlist` / `save_playlist` | Save a M3U8 playlist file when downloading a playlist. | `false` |
| `--overwrite` / `overwrite` | Overwrite existing files. | `false` |
| `--exclude-tags` / `exclude_tags` | Comma-separated tags to exclude. | `null` |
| `--truncate` / `truncate` | Maximum length of the file/folder names. | `null` |
| `--audio-quality`, `-a` / `audio_quality` | Audio quality for songs and podcasts. | `vorbis-medium` |
| `--download-mode`, `-d` / `download_mode` | Download mode for songs and podcasts. | `ytdlp` |
| `--remux-mode-audio` / `remux_mode_audio` | Remux mode for songs and podcasts. | `ffmpeg` |
| `--lrc-only`, `-l` / `lrc_only` | Download only the synced lyrics. | `false` |
| `--no-lrc` / `no_lrc` | Don't download the synced lyrics. | `false` |
| `--video-format` / `video_format` | Video format. | `mp4` |
| `--remux-mode-video` / `remux_mode_video` | Remux mode for videos. | `ffmpeg` |
| `--no-config-file`, `-n` / - | Do not use a config file. | `false` |
### Tag variables
The following variables can be used in the template folder/file and/or in the `exclude_tags` list:
- `album`
- `album_artist`
- `artist`
- `compilation`
- `composer`
- `copyright`
- `cover`
- `disc`
- `disc_total`
- `isrc`
- `label`
- `lyrics`
- `media_type`
- `playlist_artist`
- `playlist_title`
- `playlist_track`
- `publisher`
- `producer`
- `rating`
- `release_date`
- `release_year`
- `title`
- `track`
- `track_total`
- `url`
### Audio qualities
The following qualities are available:
* `vorbis-high` (320kbps, requires an active premium subscription)
* `vorbis-medium` (160kbps)
* `vorbis-low` (96kbps)
* `aac-medium` (128kbps)
* `aac-high` (256kbps, requires an active premium subscription)
### Video formats
The following video formats are available:
* `mp4`
* `webm`
* `ask`
* When using this option, Votify will ask you which audio and video codec to use that is available for the video.
### Download modes
The following modes are available:
* `ytdlp`
* `aria2c`
* Will not be used for downloading videos
* Faster than `ytdlp`
### Video remux modes
The following remux modes for videos are available:
* `ffmpeg`
* `mp4box`
### Audio remux modes
The following remux modes for songs and podcasts are available when downloading in AAC quality:
* `ffmpeg`
* `mp4box`
* `mp4decrypt`
### Credits
* [spotify-oggmp4-dl](https://github.com/DevLARLEY/spotify-oggmp4-dl)
* [spsync](https://github.com/baltitenger/spsync)
* [unplayplay](https://git.gay/uhwot/unplayplay)