release 8.5.0 (#312)

GETTING_STARTED.md

@@ -2,59 +2,71 @@
 
 ### Pre-requisites
 
-You need Python 3.6+. To download songs as MP3, you will need ffmpeg.  
+You need Python 3.6+. To download songs as MP3, you will need ffmpeg.
 
 - Linux users can get them by installing libav-tools by using apt-get `sudo apt-get install -y libav-tools`) or a package manager which comes with your distro
-- Windows users can download FFMPEG pre-built binaries from [here](http://ffmpeg.zeranoe.com/builds/). Extract the file using [7-zip](http://7-zip.org/) to a foldrer and [add the folder to your PATH environment variable](http://www.wikihow.com/Install-FFmpeg-on-Windows) 
+- Windows users can download FFMPEG pre-built binaries from [here](http://ffmpeg.zeranoe.com/builds/). Extract the file using [7-zip](http://7-zip.org/) to a foldrer and [add the folder to your PATH environment variable](http://www.wikihow.com/Install-FFmpeg-on-Windows)
 
 1.  Install using pip
 
         pip3 install spotify_dl
 
-2.  Login to [Spotify developer console](https://developer.spotify.com/my-applications/#!/applications) and click on "Create an App". Fill in details for name and description
+1.  Login to [Spotify developer console](https://developer.spotify.com/my-applications/#!/applications) and click on "Create an App". Fill in details for name and description
+
+1.  Make a note of Client ID and Client Secret. These values need to be then set `SPOTIPY_CLIENT_ID`, `SPOTIPY_CLIENT_SECRET` environment variables respectively.
 
-3.  Make a note of Client ID and Client Secret. These values need to be then set `SPOTIPY_CLIENT_ID`, `SPOTIPY_CLIENT_SECRET` environment variables respectively.
+    You can set environment variables as mentioned below:
 
-    You can set environment variables as mentioned below: 
-
     Linux:
 
             export SPOTIPY_CLIENT_ID=your-spotify-client-id
             export SPOTIPY_CLIENT_SECRET=your-spotify-client-secret
 
     Windows Powershell:
-            $env:SPOTIPY_CLIENT_ID='your-spotify-client-id'
-            $env:SPOTIPY_CLIENT_SECRET='your-spotify-client-secret'
-            
+    $env:SPOTIPY_CLIENT_ID=your-spotify-client-id
+    $env:SPOTIPY_CLIENT_SECRET=your-spotify-client-secret
+
     Windows CMD:
-            set SPOTIPY_CLIENT_ID=your-spotify-client-id
-            set SPOTIPY_CLIENT_SECRET=your-spotify-client-secret
+    set SPOTIPY_CLIENT_ID=your-spotify-client-id
+    set SPOTIPY_CLIENT_SECRET=your-spotify-client-secret
 
     See [this question](http://superuser.com/a/284351/4377) for more info,
 
-4. Run the script using `spotify_dl`. spotify_dl accepts different parameters, for more details run `spotify_dl -h`. 
-
-   For most users `spotify_dl -l spotify_playlist_link -o download_directory` should do where
-   
-   - `spotify_playlist_link` is a link to Spotify's playlist. You can get it from the 3-dot menu. 
-    
-    ![image](images/spotify-playlist.png)   
-   
-   spotify_dl also supports downloading multiple playlist, you can pass them like below:
-   
-   `spotify_dl -l spotify_playlist1 spotify_playlist2 -o download_directory`
-   
+1.  Run the script using `spotify_dl`. spotify_dl accepts different parameters, for more details run `spotify_dl -h`.
+
+    For most users `spotify_dl -l spotify_playlist_link -o download_directory` should do where
+
+    - `spotify_playlist_link` is a link to Spotify's playlist. You can get it from the 3-dot menu.
+
+    ![image](images/spotify-playlist.png)
+
+    spotify_dl also supports downloading multiple playlist, you can pass them like below:
+
+    `spotify_dl -l spotify_playlist1 spotify_playlist2 -o download_directory`
+
     - `download_directory` is the location where the songs must be downloaded to. If you give a `.` then it will download to the current directory.
 
-5.  To retrieve download songs as MP3, you will need to install ffmpeg. If you prefer to skip MP3 conversion, pass `-m` or `--skip_mp3` as a parameter when running the script
+1.  To retrieve download songs as MP3, you will need to install ffmpeg. If you prefer to skip MP3 conversion, pass `-m` or `--skip_mp3` as a parameter when running the script
 
-- Linux users can get them by installing libav-tools by using apt-get (`sudo apt-get install -y libav-tools`) if you'rte using a Debian/Ubuntu  or a package manager which comes with your distro
-- Windows users can download FFMPEG pre-built binaries from [here](http://ffmpeg.zeranoe.com/builds/). Extract the file using [7-zip](http://7-zip.org/) to a foldrer and [add the folder to your PATH environment variable](http://www.wikihow.com/Install-FFmpeg-on-Windows)
+    - Linux users can get them by installing libav-tools by using apt-get (`sudo apt-get install -y libav-tools`) if you'rte using a Debian/Ubuntu or a package manager which comes with your distro
+    - Windows users can download FFMPEG pre-built binaries from [here](http://ffmpeg.zeranoe.com/builds/). Extract the file using [7-zip](http://7-zip.org/) to a foldrer and [add the folder to your PATH environment variable](http://www.wikihow.com/Install-FFmpeg-on-Windows)
+
+1.  If you prefer to skip MP3 conversion, pass `-m` or `--skip_mp3` as a parameter when running the script
+
+1.  If you wish to download via proxy, pass `-p` flag with the URL of the proxy
+
+    For HTTP:
+
+         spotify_dl -p "http://username:password@hostname:port" or "http://hostname:port"
+
+    For SOCKS5
+
+         spotify_dl -p "socks5://username:password@hostname:port" or "socks5://hostname:port"
+
+1.  Spotify-dl can make use of SponsorBlock and skip non-music sections when downloading from YouTube. This is disabled by default and can be enabled using:
+
+        spotify_dl -l spotify_playlist_link -s y
 
-   - `download_directory` is the location where the songs must be downloaded to. If you give a `.` then it will download to the current directory.
-
-6. If you prefer to skip MP3 conversion, pass `-m` or `--skip_mp3` as a parameter when running the script
-
 ### Use Docker
 
 Build the Docker image from the Dockerfile, run the following command in the spotify_dl root directory: `docker build -t spotify_dl .`

README.md

@@ -54,7 +54,7 @@ Pull requests and any contributions are always welcome. Please open an issue wit
 
 #### Running tests
 
-At the moment, there are barely any tests but PRs always welcome to improve this. Tests are setup and run with pytest, run
+Tests are setup and run with pytest, run
 
     make tests
 

spotify_dl/constants.py

@@ -3,7 +3,7 @@
 
 __all__ = ["VERSION"]
 
-VERSION = "8.4.0"
+VERSION = "8.5.0"
 
 if os.getenv("XDG_CACHE_HOME") is not None:
     SAVE_PATH = os.getenv("XDG_CACHE_HOME") + "/spotifydl"