glomatico/votify
1
0
Fork 0
mirror of https://github.com/glomatico/votify.git synced 2026-09-26 19:12:27 +02:00
Code Issues Packages Projects Releases 5 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Rafael Moraes
2024-09-23 13:58:24 -03:00
parent 57515febd0
commit 56ed7dd1d3
1 changed files with 115 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+115 -48
View File
@@ -1,10 +1,11 @@
# Votify
A Python CLI app for downloading songs/podcasts from Spotify.
A Python CLI app for downloading songs/podcasts/videos from Spotify.
**Discord Server:** https://discord.gg/aBjMEZ9tnq
## Features
* Download songs and podcasts in Vorbis 96/128kbps or in 320kbps with a premium account
* Download songs and podcasts in Vorbis or AAC
* Download podcast videos and music videos with a premium account
* Support for artist links to download all of their albums
* Download synced lyrics
* Highly configurable
@@ -15,8 +16,24 @@ A Python CLI app for downloading songs/podcasts from Spotify.
* You can get your cookies by using one of the following extensions on your browser of choice at the Spotify website with your account signed in:
* Firefox: https://addons.mozilla.org/addon/export-cookies-txt
* Chromium based browsers: https://chrome.google.com/webstore/detail/gdocmgbfkjnnpapoeobnolbbkoibbcif
* Unplayplay
* Build it from source: https://git.gay/glomatico/unplayplay.
### Optional dependencies
The following dependencies are optional and have to be added to your PATH or specified its path using the command-line arguments/config file.
* [FFmpeg](https://ffmpeg.org/download.html)
* [MP4Box](https://gpac.io/downloads/gpac-nightly-builds/)
* [Shaka Packager](https://github.com/shaka-project/shaka-packager/releases/latest)
* [mp4decrypt](https://www.bento4.com/downloads/)
* [aria2c](https://github.com/aria2/aria2/releases)
* .wvd file
* 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.
* .wvd files extracted from emulated devices may not work.
#### Use cases
* Downloading podcast videos in MP4 requires either FFmpeg or MP4Box.
* Downloading podcast videos in WebM requires FFmpeg.
* Downloading songs in AAC requires a .wvd file and either FFmpeg, mp4decrypt or MP4Box and mp4decrypt.
* Downloading music videos in MP4 requires a .wvd file and either FFmpeg and mp4decrypt or MP4Box and mp4decrypt.
* Downloading music videos in WebM requires a .wvd file, FFmpeg and Shaka Packager when downloading in WebM.
## Installation
1. Install the package `votify` using pip
@@ -24,9 +41,7 @@ A Python CLI app for downloading songs/podcasts from Spotify.
pip install votify
```
2. Set up the `cookies.txt`.
* You can either move to the current directory from which you will be running Votify or specify its path using the command line arguments/config file.
3. Set up Unplayplay
* You can either add it to your PATH or specify its path using the command line arguments/config file.
* You can either move to the current directory from which you will be running Votify or specify its path using the command-line arguments/config file.
## Usage
```bash
@@ -42,6 +57,25 @@ votify [OPTIONS] URLS...
```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/1ukP6tpWlFWiv0ovPmi1Q1" --enable-videos
```
* Download a music video 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"
@@ -54,45 +88,56 @@ votify [OPTIONS] URLS...
* Enter - Confirm selection
## Configuration
Votify can be configured using the command line arguments or the config file.
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. | `10` |
| `--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. | `<home>/.votify/config.json` |
| `--log-level` / `log_level` | Log level. | `INFO` |
| `--print-exceptions` / `print_exceptions` | Print exceptions. | `false` |
| `--cookies-path` / `cookies_path` | Path to cookies file. | `./cookies.txt` |
| `--quality`, `-q` / `quality` | Audio quality. | `medium` |
| `--output-path`, `-o` / `output_path` | Path to output directory. | `./Spotify` |
| `--temp-path` / `temp_path` | Path to temporary directory. | `./temp` |
| `--download-mode`, `-d` / `download_mode` | Download mode. | `ytdlp` |
| `--aria2c-path` / `aria2c_path` | Path to aria2c binary. | `aria2c` |
| `--unplayplay-path` / `unplayplay_path` | Path to unplayplay binary. | `unplayplay` |
| `--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 episodes (podcasts). | `{track:02d} {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`, `-s` / `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` |
| `--lrc-only`, `-l` / `lrc_only` | Download only the synced lyrics. | `false` |
| `--no-lrc` / `no_lrc` | Don't download the synced lyrics. | `false` |
| `--no-config-file`, `-n` / - | Do not use a config file. | `false` |
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. | `10` |
| `--enable-videos` / `enable_videos` | Enable video downloads when available. | `false` |
| `--download-music-videos` / `download_music_videos` | Attempt to download music videos from songs (can lead to incorrect results). | `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. | `<home>/.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` |
| `--unplayplay-path` / `unplayplay_path` | Path to unplayplay binary. | `unplayplay` |
| `--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:
@@ -108,9 +153,11 @@ The following variables can be used in the template folder/file and/or in the `e
- `isrc`
- `label`
- `lyrics`
- `media_type`
- `playlist_artist`
- `playlist_title`
- `playlist_track`
- `publisher`
- `producer`
- `rating`
- `release_date`
@@ -119,22 +166,42 @@ The following variables can be used in the template folder/file and/or in the `e
- `track`
- `track_total`
- `url`
### Download qualities
### Audio qualities
The following qualities are available:
* `high` (320kbps, requires premium account)
* `medium` (160kbps)
* `low` (96kbps)
* `vorbis-high` (320kbps, requires premium account)
* `vorbis-medium` (160kbps)
* `vorbis-low` (96kbps)
* `aac-medium` (128kbps)
* `aac-high` (256kbps)
## 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`
* Can be obtained from here: https://github.com/aria2/aria2/releases
## 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)
* [unplayplay](https://git.gay/uhwot/unplayplay)