Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

readme Various fixes & changes #1054

Merged
merged 7 commits into from
Jan 6, 2021
Merged

readme Various fixes & changes #1054

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7f451cd
Various fixes & changes
Silverarmor Dec 22, 2020
75ce674
Update README.md
Silverarmor Dec 22, 2020
c3d211b
Opting for lines rather than <br/> tags
Silverarmor Dec 22, 2020
aa425ec
Updated Example Songs
Silverarmor Dec 22, 2020
a61311a
Formatting to bold & italics
Silverarmor Dec 22, 2020
2b2c17b
Update README.md
Silverarmor Jan 2, 2021
20f88b5
Update README.md
Silverarmor Jan 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
64 changes: 29 additions & 35 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
What spotDL does:

1. Downloads music from YouTube as an MP3 file
2. Applies basic metadata gathered from spotify such as:
2. Applies basic metadata gathered from Spotify such as:
- Track Name
- Track Number
- Album
Expand All @@ -20,108 +20,107 @@ What spotDL does:

### Announcing spotDL v3

We rebuilt spotDL from scratch to be much faster, simpler, and better than the old spotDL. The documentation is also a work in progress.
We rebuilt spotDL from scratch to be faster, simpler, and better than v2 of spotDL. Documentation is also a work in progress.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better than spotDL v2?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

documentation is still a work in progress (why the 'also a work in progress', grammar isn't my strong point - just asking)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

documentation is still a work in progress (why the 'also a work in progress', grammar isn't my strong point - just asking)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

better than spotDL v2?

Will fix.

documentation is still a work in progress (why the 'also a work in progress', grammar isn't my strong point - just asking)

Yeah sounds a bit off. Wasn't my wording, was there when I started work on the readme. Will fix.


⚠ We have dropped active development of spotDL v2 due to support and maintainability. No focused efforts will be made to resolve v2 specific issues.
⚠ We have dropped the active development of spotDL v2 due to support and maintainability. No focused efforts will be made to resolve v2 specific issues.

#### Join the [spotDL discussion](https://github.com/spotDL/spotify-downloader/discussions?discussions_q=category%3AGeneral)!

<br/>

## Installation

You need to download FFmpeg to use this tool. Download and installation instructions can be found at [FFmpeg.org](https://ffmpeg.org/)

### Installing spotDL

- Recommended Stable Version:

```
$ pip install spotdl
```

- Alternatively, for the latest version (not necessarily stable):
- Latest Version: __(NOT NECESSARILY STABLE)__

```
$ pip install https://github.com/spotDL/spotify-downloader/archive/next-rel-dev.zip
```

_The availability of YouTube Music in your country is important for spotDL to work since we use YouTube Music to filter out our search results. To check if YouTube Music is available in your country, visit [YouTube Music](https://music.youtube.com)._
___YouTube Music must be available in your country for spotDL to work. This is because we use YouTube Music to filter search results. You can check if YouTube Music is available in your country, by visiting [YouTube Music](https://music.youtube.com).___

## Usage (instructions for v3)
## Usage (Instructions for v3)

- To download a song, run:

```
$ spotdl [trackUrl]
```

ex. `spotdl https://open.spotify.com/track/08mG3Y1vljYA6bvDt4Wqkj?si=SxezdxmlTx-CaVoucHmrUA`
<br/>
ex. `spotdl https://open.spotify.com/track/0VjIjW4GlUZAMYd2vXMi3b?si=1stnMF5GSdClnIEARnJiiQ`


- To download an album, run:

```
$ spotdl [albumUrl]
```

ex. `spotdl https://open.spotify.com/album/2YMWspDGtbDgYULXvVQFM6?si=gF5dOQm8QUSo-NdZVsFjAQ`
<br/>
ex. `spotdl https://open.spotify.com/album/4yP0hdKOZPNshxUOjY0cZj?si=AssgQQrVTJqptFe7X92jNg`


- To download a playlist, run:

```
$ spotdl [playlistUrl]
```

ex. `spotdl https://open.spotify.com/playlist/37i9dQZF1DWXhcuQw7KIeM?si=xubKHEBESM27RqGkqoXzgQ`
<br/>
ex. `spotdl https://open.spotify.com/playlist/37i9dQZF1E8UXBoz02kGID?si=oGd5ctlyQ0qblj_bL6WWow`


- To search for and download a song, run (with quotation marks):
_(Note: This may not be very accurate)_
- To search for and download a song, run, __with quotation marks__:
_Note: This is not accurate and often causes errors._

```
$ spotdl '[songQuery]'
```

ex. `spotdl 'The HU - Sugaan Essenna'`
ex. `spotdl 'The Weeknd - Blinding Lights'`

<br/>

- To resume a failed/incomplete download, run:

```
$ spotdl [pathToTrackingFile]
```

ex. `spotdl 'Sugaan Essenna.spotdlTrackingFile'`
ex. `spotdl 'The Weeknd - Blinding Lights.spotdlTrackingFile'`

_`.spotDlTrackingFiles` are automatically created when a download starts, and deleted on completion_
_`.spotdlTrackingFile`s are automatically created when a download starts and deleted on completion_

<br/>

You can queue up multiple download tasks by separating the arguments with spaces:

```
$ spotdl [songQuery1] [albumUrl] [songQuery2] ... (order does not matter)
```

ex. `spotdl 'The Hu - Sugaan Essenna' https://open.spotify.com/playlist/37i9dQZF1DWXhcuQw7KIeM?si=xubKHEBESM27RqGkqoXzgQ ...`
ex. `spotdl 'The Weeknd - Blinding Lights'https://open.spotify.com/playlist/37i9dQZF1E8UXBoz02kGID?si=oGd5ctlyQ0qblj_bL6WWow ...`

<br/>

_spotDL downloads up to 4 songs in parallel, so try to download albums and playlists, instead of tracks for a faster experience._

## `pipx` isolated environment alternative
_spotDL downloads up to 4 songs in parallel, so for a faster experience, download albums and playlist, rather than tracks._

For users who are not familiar with `pipx`, you can use it to run the script _without_ installing the spotDL package and all the dependencies globally with pip. (Effectively skipping over the [Installation](https://github.com/spotDL/spotify-downloader#Installation) step)
## `pipx` Isolated Environment Alternative

First you will need `pipx`
For users who are not familiar with `pipx`, it can be used to run scripts __without__ installing the spotDL package and all the dependencies globally with pip. (Effectively skipping over the [Installation](https://github.com/spotDL/spotify-downloader#Installation) step)

First, you will need to install `pipx` by running:

```
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```

Then you can jump directly to running spotDL with:
Next, you can jump directly to running spotDL with:

```
pipx run spotdl ...
Expand All @@ -134,7 +133,7 @@ pipx run spotdl ...
$ git clone https://github.com/spotDL/spotify-downloader.git
$ cd spotify-downloader
```
2. Setup venv (optional)
2. Setup venv (Optional)
- Windows
```
$ py -3 -m venv env
Expand All @@ -150,18 +149,13 @@ pipx run spotdl ...
$ pip install -e .
```

- Use as Command (no need to re-install after file changes)
- Use as command (no need to re-install after file changes)
```
$ spotdl [ARGUMENTS]
```

## Thanks for developing v3
## Thank Yous

1. [@ritiek](https://github.com/ritiek) for creating and maintaining spotDL for 4 years
2. [@rocketinventor](https://github.com/rocketinventor) for figuring out YouTube Music querying
3. [@Mikhail-Zex](https://github.com/Mikhail-Zex) for, never mind...

## A few interesting forks

1. [aasmpro/spotify-downloader](https://github.com/aasmpro/spotify-downloader)
- Sets metadata for songs that are already downloaded (v2 only.)