zspotify/README.md

90 lines
3.7 KiB
Markdown
Raw Normal View History

2021-10-20 09:09:40 +02:00
![Stars](https://img.shields.io/github/stars/Footsiefat/zspotify.svg)
![Forks](https://img.shields.io/github/forks/Footsiefat/zspotify.svg)
![Size](https://img.shields.io/github/repo-size/Footsiefat/zspotify)
2021-10-20 09:02:33 +02:00
# ZSpotify
2021-10-20 08:39:37 +02:00
### A Spotify downloader needing only a python interpreter and ffmpeg.
2021-10-20 08:39:37 +02:00
<p align="center">
<img src="https://user-images.githubusercontent.com/12180913/138040605-c9d46e45-3830-4a4b-a7ac-c56bb0d76335.png">
</p>
2021-10-18 07:51:25 +02:00
2021-10-22 06:26:28 +02:00
[Discord Server](https://discord.gg/skVNQKtyFq) - [Matrix Server](https://matrix.to/#/#zspotify:matrix.org) - [Gitea Mirror](https://git.robinsmediateam.dev/Footsiefat/zspotify) - [Main Site](https://footsiefat.github.io/)
2021-10-13 09:30:07 +02:00
```
2021-10-18 07:51:25 +02:00
Requirements:
2021-10-18 07:50:10 +02:00
Binaries
2021-10-24 09:36:31 +02:00
- Python 3.9 or greater
2021-10-18 07:51:25 +02:00
- ffmpeg*
- Git**
2021-10-13 09:30:07 +02:00
2021-10-18 07:50:10 +02:00
Python packages:
2021-10-18 10:08:54 +02:00
- pip install -r requirements.txt
2021-10-18 07:51:25 +02:00
```
2021-10-20 09:01:47 +02:00
2021-10-24 19:09:15 +02:00
\*ffmpeg can be installed via apt for Debian-based distros or by downloading the binaries from [ffmpeg.org](https://ffmpeg.org) and placing them in your %PATH% in Windows. Mac users can install it with [Homebrew](https://brew.sh) by running `brew install ffmpeg`.
\*\*Git can be installed via apt for Debian-based distros or by downloading the binaries from [git-scm.com](https://git-scm.com/download/win) for Windows.
2021-10-25 03:59:40 +02:00
### Command line usage:
2021-10-20 09:01:47 +02:00
```
2021-10-25 03:59:40 +02:00
Basic usage:
python zspotify Loads search prompt to find then download a specific track, album or playlist
python zspotify <track/album/playlist/episode url> Downloads the track, album, playlist or podcast episode specified as a command line argument
python zspotify <artist url> Downloads all albums by specified artist
2021-10-20 09:01:47 +02:00
Extra command line options:
-p, --playlist Downloads a saved playlist from your account
-ls, --liked-songs Downloads all the liked songs from your account
2021-10-19 02:44:00 +02:00
Options that can be configured in zs_config.json:
2021-10-21 09:32:42 +02:00
ROOT_PATH Change this path if you don't like the default directory where ZSpotify saves the music
ROOT_PODCAST_PATH Change this path if you don't like the default directory where ZSpotify saves the podcasts
SKIP_EXISTING_FILES Set this to false if you want ZSpotify to overwrite files with the same name rather than skipping the song
2021-10-21 09:32:42 +02:00
2021-10-24 18:35:04 +02:00
MUSIC_FORMAT Can be "mp3" or "ogg", mp3 is required for track metadata however ogg is slightly higher quality as it is not transcoded.
FORCE_PREMIUM Set this to true if ZSpotify isn't automatically detecting that you are using a premium account
2021-10-21 09:32:42 +02:00
ANTI_BAN_WAIT_TIME Change this setting if the time waited between bulk downloads is too high or low
OVERRIDE_AUTO_WAIT Change this to true if you want to completely disable the wait between songs for faster downloads with the risk of instability
2021-10-20 09:01:47 +02:00
```
2021-10-24 22:32:50 +02:00
2021-10-25 03:06:26 +02:00
### Docker Usage
```
2021-10-25 03:06:26 +02:00
Build the docker image from the Dockerfile:
docker build -t zspotify .
Create and run a container from the image:
docker run --rm -v "$PWD/ZSpotify Music:/ZSpotify Music" -v "$PWD/ZSpotify Podcasts:/ZSpotify Podcasts" -it zspotify
2021-10-24 22:32:50 +02:00
```
### Will my account get banned if I use this tool?
Currently no user has reported their account getting banned after using ZSpotify.
This isn't to say _you_ won't get banned as it is technically against Spotify's TOS.
**Use ZSpotify at your own risk**, the developers of ZSpotify are not responsible if your account gets banned.
2021-10-19 02:18:53 +02:00
2021-10-24 01:56:36 +02:00
### What do I do if I see "Your session has been terminated"?
2021-10-24 01:56:36 +02:00
If you see this, don't worry! Just try logging back in. If you see the incorrect username or password error, reset your password and you should be able to log back in and continue using Spotify.
### Contributing
2021-10-24 14:24:47 +02:00
Please refer to [CONTRIBUTING](CONTRIBUTING.md)
### Changelog
Please refer to [CHANGELOG](CHANGELOG.md)
### Common Errors
Please refer to [COMMON_ERRORS](COMMON_ERRORS.md)