<!--- mdformat-toc start --slug=github --->
<!---
!!! IF EDITING THE README, ENSURE TO COPY THE WHOLE FILE TO index.md in `/docs/` AND REMOVE THE REFERENCES TO ReadTheDocs THERE.
--->
<div align="center">
# spotDL v4
**spotDL** finds songs from Spotify playlists on YouTube and downloads them - along with album art, lyrics and metadata.
[](https://github.com/spotDL/spotify-downloader/blob/master/LICENSE)
[](https://pypi.org/project/spotdl/)
[](https://pypi.org/project/spotdl/)
[](https://discord.gg/xCa23pwJWY)
> spotDL: The fastest, easiest and most accurate command-line music downloader.
</div>
______________________________________________________________________
**[Read the documentation on ReadTheDocs!](https://spotdl.readthedocs.io)**
______________________________________________________________________
## Installation
Refer to our [Installation Guide](https://spotdl.rtfd.io/en/latest/installation/) for more details.
### Python (Recommended Method)
- _spotDL_ can be installed by running `pip install spotdl`.
- To update spotDL run `pip install --upgrade spotdl`
> On some systems you might have to change `pip` to `pip3`.
<details>
<summary style="font-size:1.25em"><strong>Other options</strong></summary>
- Prebuilt executable
- You can download the latest version from the
[Releases Tab](https://github.com/spotDL/spotify-downloader/releases)
- On Termux
- `curl -L https://raw.githubusercontent.com/spotDL/spotify-downloader/master/scripts/termux.sh | sh`
- Arch
- There is an [Arch User Repository (AUR) package](https://aur.archlinux.org/packages/python-spotdl/) for
spotDL.
- Docker
- Build image:
```bash
docker build -t spotdl .
```
- Launch container with spotDL parameters (see section below). You need to create mapped
volume to access song files
```bash
docker run --rm -v $(pwd):/music spotdl download [trackUrl]
```
- Build from source
```bash
git clone https://github.com/spotDL/spotify-downloader && cd spotify-downloader
pip install poetry
poetry install
poetry run python3 scripts/build.py
```
An executable is created in `spotify-downloader/dist/`.
</details>
### Installing FFmpeg
FFmpeg is required for spotDL. If using FFmpeg only for spotDL, you can simply install FFmpeg to your spotDL installation directory:
`spotdl --download-ffmpeg`
We recommend the above option, but if you want to install FFmpeg system-wide,
follow these instructions
- [Windows Tutorial](https://windowsloop.com/install-ffmpeg-windows-10/)
- OSX - `brew install ffmpeg`
- Linux - `sudo apt install ffmpeg` or use your distro's package manager
## Usage
Using SpotDL without options::
```sh
spotdl [urls]
```
You can run _spotDL_ as a package if running it as a script doesn't work:
```sh
python -m spotdl [urls]
```
General usage:
```sh
spotdl [operation] [options] QUERY
```
There are different **operations** spotDL can perform. The *default* is `download`, which simply downloads the songs from YouTube and embeds metadata.
The **query** for spotDL is usually a list of Spotify URLs, but for some operations like **sync**, only a single link or file is required.
For a list of all **options** use ```spotdl -h```
<details>
<summary style="font-size:1em"><strong>Supported operations</strong></summary>
- `save`: Saves only the metadata from Spotify without downloading anything.
- Usage:
`spotdl save [query] --save-file {filename}.spotdl`
- `web`: Starts a web interface instead of using the command line. However, it has limited features and only supports downloading single songs.
- `url`: Get direct download link for each song from the query.
- Usage:
`spotdl url [query]`
- `sync`: Updates directories. Compares the directory with the current state of the playlist. Newly added songs will be downloaded and removed songs will be deleted. No other songs will be downloaded and no other files will be deleted.
- Usage:
`spotdl sync [query] --save-file {filename}.spotdl`
This create a new **sync** file, to update the directory in the future, use:
`spotdl sync {filename}.spotdl`
- `meta`: Updates metadata for the provided song files.
</details>
## Music Sourcing and Audio Quality
spotDL uses YouTube as a source for music downloads. This method is used to avoid any issues related to downloading music from Spotify.
> **Note**
> Users are responsible for their actions and potential legal consequences. We do not support unauthorized downloading of copyrighted material and take no responsibility for user actions.
### Audio Quality
spotDL downloads music from YouTube and is designed to always download the highest possible bitrate; which is 128 kbps for regular users and 256 kbps for YouTube Music premium users.
Check the [Audio Formats](docs/usage.md#audio-formats-and-quality) page for more info.
## Contributing
Interested in contributing? Check out our [CONTRIBUTING.md](docs/CONTRIBUTING.md) to find
resources around contributing along with a guide on how to set up a development environment.
#### Join our amazing community as a code contributor, and help accelerate
<br><br>
<a href="https://github.com/spotDL/spotify-downloader/graphs/contributors">
<img class="dark-light" src="https://contrib.rocks/image?repo=spotDL/spotify-downloader&anon=0&columns=25&max=100&r=true" />
</a>
## Donate
help support the development and maintenance of the software ❤️
[](https://paypal.me/kko7)
[](https://ko-fi.com/xnetcat)
## License
This project is Licensed under the [MIT](/LICENSE) License.
Raw data
{
"_id": null,
"home_page": "https://github.com/spotDL/spotify-downloader/",
"name": "spotdl",
"maintainer": "xnetcat",
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": "xnetcat.dev@gmail.com",
"keywords": "spotify, downloader, spotdl, music",
"author": "spotDL Team",
"author_email": "spotdladmins@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/6f/10/3306d812a9b819c23eb67c5e616176fb32aca167c0c51b03961a6107ea1d/spotdl-4.2.5.tar.gz",
"platform": null,
"description": "\n<!--- mdformat-toc start --slug=github --->\n\n<!---\n!!! IF EDITING THE README, ENSURE TO COPY THE WHOLE FILE TO index.md in `/docs/` AND REMOVE THE REFERENCES TO ReadTheDocs THERE.\n--->\n\n<div align=\"center\">\n\n# spotDL v4\n\n**spotDL** finds songs from Spotify playlists on YouTube and downloads them - along with album art, lyrics and metadata.\n\n\n[](https://github.com/spotDL/spotify-downloader/blob/master/LICENSE)\n[](https://pypi.org/project/spotdl/)\n[](https://pypi.org/project/spotdl/)\n\n[](https://discord.gg/xCa23pwJWY)\n\n> spotDL: The fastest, easiest and most accurate command-line music downloader.\n</div>\n\n______________________________________________________________________\n**[Read the documentation on ReadTheDocs!](https://spotdl.readthedocs.io)**\n______________________________________________________________________\n\n\n## Installation\n\nRefer to our [Installation Guide](https://spotdl.rtfd.io/en/latest/installation/) for more details.\n\n### Python (Recommended Method)\n - _spotDL_ can be installed by running `pip install spotdl`.\n - To update spotDL run `pip install --upgrade spotdl`\n\n > On some systems you might have to change `pip` to `pip3`.\n\n<details>\n <summary style=\"font-size:1.25em\"><strong>Other options</strong></summary>\n\n- Prebuilt executable\n - You can download the latest version from the\n [Releases Tab](https://github.com/spotDL/spotify-downloader/releases)\n- On Termux\n - `curl -L https://raw.githubusercontent.com/spotDL/spotify-downloader/master/scripts/termux.sh | sh`\n- Arch\n - There is an [Arch User Repository (AUR) package](https://aur.archlinux.org/packages/python-spotdl/) for\n spotDL.\n- Docker\n - Build image:\n\n ```bash\n docker build -t spotdl .\n ```\n\n - Launch container with spotDL parameters (see section below). You need to create mapped\n volume to access song files\n\n ```bash\n docker run --rm -v $(pwd):/music spotdl download [trackUrl]\n ```\n\n - Build from source\n\t```bash\n\tgit clone https://github.com/spotDL/spotify-downloader && cd spotify-downloader\n\tpip install poetry\n\tpoetry install\n\tpoetry run python3 scripts/build.py\n\t```\n\tAn executable is created in `spotify-downloader/dist/`.\n\n</details>\n\n\n### Installing FFmpeg\n\nFFmpeg is required for spotDL. If using FFmpeg only for spotDL, you can simply install FFmpeg to your spotDL installation directory:\n`spotdl --download-ffmpeg`\n\nWe recommend the above option, but if you want to install FFmpeg system-wide,\nfollow these instructions\n\n- [Windows Tutorial](https://windowsloop.com/install-ffmpeg-windows-10/)\n- OSX - `brew install ffmpeg`\n- Linux - `sudo apt install ffmpeg` or use your distro's package manager\n\n## Usage\n\nUsing SpotDL without options::\n```sh\nspotdl [urls]\n```\nYou can run _spotDL_ as a package if running it as a script doesn't work:\n```sh\npython -m spotdl [urls]\n```\n\nGeneral usage:\n```sh\nspotdl [operation] [options] QUERY\n```\n\nThere are different **operations** spotDL can perform. The *default* is `download`, which simply downloads the songs from YouTube and embeds metadata.\n\nThe **query** for spotDL is usually a list of Spotify URLs, but for some operations like **sync**, only a single link or file is required.\nFor a list of all **options** use ```spotdl -h```\n\n<details>\n<summary style=\"font-size:1em\"><strong>Supported operations</strong></summary>\n\n- `save`: Saves only the metadata from Spotify without downloading anything.\n - Usage:\n `spotdl save [query] --save-file {filename}.spotdl`\n\n- `web`: Starts a web interface instead of using the command line. However, it has limited features and only supports downloading single songs.\n\n- `url`: Get direct download link for each song from the query.\n - Usage:\n `spotdl url [query]`\n\n- `sync`: Updates directories. Compares the directory with the current state of the playlist. Newly added songs will be downloaded and removed songs will be deleted. No other songs will be downloaded and no other files will be deleted.\n\n - Usage:\n `spotdl sync [query] --save-file {filename}.spotdl`\n\n This create a new **sync** file, to update the directory in the future, use:\n\n `spotdl sync {filename}.spotdl`\n\n- `meta`: Updates metadata for the provided song files.\n</details>\n\n## Music Sourcing and Audio Quality\n\nspotDL uses YouTube as a source for music downloads. This method is used to avoid any issues related to downloading music from Spotify.\n\n> **Note**\n> Users are responsible for their actions and potential legal consequences. We do not support unauthorized downloading of copyrighted material and take no responsibility for user actions.\n\n### Audio Quality\n\nspotDL downloads music from YouTube and is designed to always download the highest possible bitrate; which is 128 kbps for regular users and 256 kbps for YouTube Music premium users.\n\nCheck the [Audio Formats](docs/usage.md#audio-formats-and-quality) page for more info.\n\n## Contributing\n\nInterested in contributing? Check out our [CONTRIBUTING.md](docs/CONTRIBUTING.md) to find\nresources around contributing along with a guide on how to set up a development environment.\n\n#### Join our amazing community as a code contributor, and help accelerate\n<br><br>\n<a href=\"https://github.com/spotDL/spotify-downloader/graphs/contributors\">\n <img class=\"dark-light\" src=\"https://contrib.rocks/image?repo=spotDL/spotify-downloader&anon=0&columns=25&max=100&r=true\" />\n</a>\n## Donate\n\nhelp support the development and maintenance of the software \u2764\ufe0f\n\n[](https://paypal.me/kko7)\n[](https://ko-fi.com/xnetcat)\n\n## License\n\nThis project is Licensed under the [MIT](/LICENSE) License.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Download your Spotify playlists and songs along with album art and metadata",
"version": "4.2.5",
"project_urls": {
"Documentation": "https://spotdl.rtfd.io/en/latest/",
"Homepage": "https://github.com/spotDL/spotify-downloader/",
"Repository": "https://github.com/spotDL/spotify-downloader.git"
},
"split_keywords": [
"spotify",
" downloader",
" spotdl",
" music"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "460ff450f6060e95922e36a750fa5eaa39d0b28a1b0a77f1efb6180afd1d8605",
"md5": "90df87b7b1363b0ba990da0a04401039",
"sha256": "6f871272100ac93a3295f0edb167b73320fb44f45e2b6fcad0e8456da86c72fc"
},
"downloads": -1,
"filename": "spotdl-4.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90df87b7b1363b0ba990da0a04401039",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 113122,
"upload_time": "2024-03-30T15:31:02",
"upload_time_iso_8601": "2024-03-30T15:31:02.253818Z",
"url": "https://files.pythonhosted.org/packages/46/0f/f450f6060e95922e36a750fa5eaa39d0b28a1b0a77f1efb6180afd1d8605/spotdl-4.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6f103306d812a9b819c23eb67c5e616176fb32aca167c0c51b03961a6107ea1d",
"md5": "d54a5252d8fd5950fbc473a678002f8e",
"sha256": "c35ccef2e977b9cfc12650b3280366f2532bb556af9a3a79c9af82ac998fb207"
},
"downloads": -1,
"filename": "spotdl-4.2.5.tar.gz",
"has_sig": false,
"md5_digest": "d54a5252d8fd5950fbc473a678002f8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 90259,
"upload_time": "2024-03-30T15:31:05",
"upload_time_iso_8601": "2024-03-30T15:31:05.562962Z",
"url": "https://files.pythonhosted.org/packages/6f/10/3306d812a9b819c23eb67c5e616176fb32aca167c0c51b03961a6107ea1d/spotdl-4.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-30 15:31:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spotDL",
"github_project": "spotify-downloader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spotdl"
}
JSON
