From 67c325473f2f662d8a4abaebe29e0ff2cdde953b Mon Sep 17 00:00:00 2001 From: Jayden Date: Mon, 25 Oct 2021 14:14:05 -0400 Subject: [PATCH] docs(readme): add common errors markdown file --- COMMON_ERRORS.md | 11 +++++++++++ README.md | 14 +++++++++++++- 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 COMMON_ERRORS.md diff --git a/COMMON_ERRORS.md b/COMMON_ERRORS.md new file mode 100644 index 0000000..f7e93a2 --- /dev/null +++ b/COMMON_ERRORS.md @@ -0,0 +1,11 @@ +# Introduction + +Below will contain sets of errors that you might get running zspotify. Below will also contain possible fixes to these errors. It is advisable that you read this before posting your error in any support channel. + +## AttributeError: module 'google.protobuf.descriptor' has no attribute '\_internal_create_key + +_Answer:_ + +`pip install --upgrade protobuf` + +This error happens due to a potentially outdated version of protobuf, to fix it upgrade protobuf by using pip. diff --git a/README.md b/README.md index 634a450..18478a0 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ ![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) + # ZSpotify ### A Spotify downloader needing only a python interpreter and ffmpeg. +

[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/) + ``` Requirements: @@ -29,6 +32,7 @@ Python packages: \*\*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. ### Command line usage: + ``` Basic usage: python zspotify Loads search prompt to find then download a specific track, album or playlist @@ -55,7 +59,7 @@ Options that can be configured in zs_config.json: ### Docker Usage -``` +``` Build the docker image from the Dockerfile: docker build -t zspotify . Create and run a container from the image: @@ -63,15 +67,23 @@ Create and run a container from the image: ``` ### 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. ### What do I do if I see "Your session has been terminated"? + 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 + Please refer to [CONTRIBUTING](CONTRIBUTING.md) ### Changelog + Please refer to [CHANGELOG](CHANGELOG.md) + +### Common Errors + +Please refer to [COMMON_ERRORS](COMMON_ERRORS.md)