Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siddhartadutta/spotify-to-mp3
A program designed to download Spotify and SoundCloud songs, featuring built-in iBroadcast support.
https://github.com/siddhartadutta/spotify-to-mp3
apple-music docker downloader free-music-download ibroadcast music python python3 script soundcloud spotify youtube youtube-dl youtube-downloader
Last synced: 4 days ago
JSON representation
A program designed to download Spotify and SoundCloud songs, featuring built-in iBroadcast support.
- Host: GitHub
- URL: https://github.com/siddhartadutta/spotify-to-mp3
- Owner: SiddhartaDutta
- License: mit
- Created: 2023-02-01T03:44:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-01T23:58:50.000Z (6 months ago)
- Last Synced: 2024-09-30T06:24:16.167Z (4 days ago)
- Topics: apple-music, docker, downloader, free-music-download, ibroadcast, music, python, python3, script, soundcloud, spotify, youtube, youtube-dl, youtube-downloader
- Language: Python
- Homepage:
- Size: 154 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spotify to MP3
## Disclaimer
This project is designed to be both a learning tool and for experimental purposes only; **it is for educational purposes only**. **The author takes no responsibility for damage or misfunction of any kind caused by the software in this repository.** Please use both caution and common sense when using this project.
## Contents
1. [Description](#description)
1. [Badges](#badges)
1. [Visuals](#visuals)
1. [General Notes & Warnings](#general-notes--warnings)
1. [Usage Option 1 (Downloadable Docker Image)](#usage-option-1-downloadable-docker-image)
1. [Usage Option 2 (Creating a Local Docker Image)](#usage-option-2-creating-a-docker-image)
1. [Usage Option 3 (Cloning the Repository)](#usage-option-3-cloning-the-repository)
1. [Frequently Asked Questions](#frequently-asked-questions)
1. [Prerequisite Instructions](#prerequisite-instructions)
1. [Contributing](#contributing)
## Description
**Spotify to MP3** is a collection of scripts written and organized to help the user download their playlists in a relatively quick and organized manner. The MP3 files contain metadata in the ID3 format so that the MP3 files may be exported to an MP3 manager, such as iBroadcast, iTunes or Spotify, (although Spotify does not allow "premium" features for owned MP3 files), without the user having to edit metadata.
## Badges
[](./LICENSE)
## Visuals
Coming soon...
## General Notes & Warnings
WARNING: Please Update Playlists Regularly!
Large updates can fail regardless of steps taken to prevent errors.
These errors are server sided and out of my control.
**NOTE:** These instructions will refer to a 'host directory'. 'Host directory' refers to the directory containing a generated folder where your music can be found (Host > Music > Album Folders).
**NOTE:** System administrator permissions are required due to Docker. The script and subsequently generated Docker image will not work without administrator permissions.
**NOTE:** Ensure that any directory in the full path where you are installing the program does **NOT** contain spaces. Docker will not work with any spaces in the destination path.
## Usage Option 1 (Downloadable Docker Image)
### Prerequisites
Docker Engine, and an MP3 manager are ALL required for this installation process (the least demanding option).
Please follow the relevant steps here: [Prerequisite Instructions](#prerequisite-instructions)
### Instructions
The downloadable Docker image can be found here: [Link to Docker Hub](https://hub.docker.com/r/siddhartadutta/spotify-to-mp3)
#### Installing Using the Command Line
1. Open either WSL or a Bash Terminal
2. Run the following command to pull the image:
```bash
sudo docker pull siddhartadutta/spotify-to-mp3
```
3. To run the image,
* If it is your first time running the image, use
* Option 1 - Using the Direct Path
```bash
sudo docker run --name spotify_to_mp3 -it --mount type=bind,src=,target= siddhartadutta/spotify-to-mp3
```
Where PATH is the path to where you would like to be your main directory (a music folder will be created in that directory).
Example: PATH/Music/
Where PATH is defined by you and Music/ is a folder created by the program (only enter the "PATH" portion).
* Option 2 - Navigating to the Path Through the Terminal
```bash
sudo docker run --name spotify_to_mp3 -it --mount type=bind,src=$PWD,target=$PWD siddhartadutta/spotify-to-mp3
```
For this method, first use the ```cd``` command to navigate to your host directory's path. Then run the above command.
* If you have ran the image before, use
```bash
sudo docker start -ai spotify_to_mp3
```
## Usage Option 2 (Creating a Docker Image)
### Prerequisites
Docker Engine, and an MP3 manager are ALL required for this installation process (the second least demanding option).
Please follow the relevant steps here: [Prerequisite Instructions](#prerequisite-instructions)
### Instructions
The downloadable Docker image can be found here: [Link to Docker Hub](https://hub.docker.com/r/siddhartadutta/spotify-to-mp3)
#### Downloading the Source Files
* Option 1 - Newest Stable Release
1. Navigate to the home page of the repository (found [here](https://github.com/SiddhartaDutta/Spotify-to-MP3)).
1. On the right side of the screen, find the "Releases" tab. Select this tab.
1. For the newest release (the top most release on this page), click on the "Assets" dropdown to access the source code downloads.
1. Download the .zip file.
1. Unzip the folder and move the files and folders contained inside into the host directory.
1. Refer to the ["Usage"](#usage) section for the next steps.
* Option 2 - Current Development
CAUTION: Please only use this option if you are confident as this version is the most unstable and may not even work depending on the specific update being used. This version uses the last commit from the development branch.
1. Near the top, find the branches dropdown. It should be defaulted to the "main" branch.
1. Select the dev branch (will be either titled "dev" or "CLI_UI_DEV").
1. Click on the green "Code" button and then download the the .zip (click the "Download ZIP" button).
1. Unzip the folder and move the files and folders contained inside into the host directory.
1. Refer to the ["Usage"](#usage) section for the next steps.
#### Usage
There is currently no native Powershell support. The following commands are universal to both Bash and WSL (macOS, Windows with WSL, and any Linux-based system should work).
* To build the image and run a container, use:
```
sudo ./setup.sh
```
* If being told that the script cannot run, use:
```
sudo chmod +x setup.sh
```
before trying the first command again.
* If you have run the setup script before, use:
```.sh
sudo docker start -ai spotify_to_mp3
```
## Usage Option 3 (Cloning the Repository)
This option runs the program locally. There are option specific prerequisites that will be covered in this section rather than in the prerequisite section.
It is recommended you have a basic understanding of both Python and terminal usage for this option.
### Language Prerequisite
* [Python3](https://www.python.org/downloads/)
Please follow the linked instructions should you not already have Python (this program utilizes Python 3.10.11)
### Module Prerequisites
#### List of Modules to be Installed
* [yt-dlp](https://pypi.org/project/yt-dlp/)
* [spotipy](https://pypi.org/project/spotipy/)
* [dotenv](https://pypi.org/project/python-dotenv/)
* [requests](https://pypi.org/project/requests/)
* [pydub](https://pypi.org/project/pydub/)
* [ibroadcast](https://pypi.org/project/ibroadcast/)
* [tqdm](https://pypi.org/project/tqdm/)
#### Installing Modules
Running the following command in your virtual environment (or where ever you wish to have the modules) should download all required and non-standard modules:
```bash
pip3 install yt_dlp python-requests python-dotenv pydub ibroadcast tqdm && pip3 install spotipy --upgrade && pip3 install --upgrade yt-dlp
```
### Cloning
First, navigate to the base directory in your terminal. Then you can then clone the repository using:
```bash
git clone https://github.com/SiddhartaDutta/Spotify-to-MP3.git
```
### Running the Program
Ensuring you are in the clone's directory, you can run the following command:
```bash
python3 main.py
```
## Frequently Asked Questions
**How is the tool designed to be used?**
Answer
***
When using iBroadcast for your music library, your songs will be added in the same order they appear when you decide to update your playlist. If you wish for iBroadcast to mirror Spotify (only when uploading initially), then you can use the tool regularly with no worry about song order specification.
When using Apple Music for your music library, it is highly recommended that when creating playlists on Spotify, you create them grouped as albums; all songs belonging to an album should be grouped chronologically together. This style of listening involves fully listening to an album at once and adding desired songs then.
Note for Apple Music: However, if you do not wish to listen to music in an album fashion, you can still easily add albums to your MP3 manager. After downloading your music, you can sort the album folders by those edited most recent. This way, all albums will be listed that need to be transferred (is beneficial when there are a large amount of albums/singles).
***
**How do I get a Spotify playlist's ID?**
Answer
***
First get the share link to a playlist. The playlist ID is after the '/playlist/' to the first question mark.
Example: https://open.spotify.com/playlist/0CdFo515yc2vcintnGYG3b?si=e8f762d893c64743
The ID is **0CdFo515yc2vcintnGYG3b**
***
**How do I get a Spotify song's ID?**
Answer
***
First get the share link to a song. The song ID is after the '/track/' to the first question mark.
Example: https://open.spotify.com/track/4PTG3Z6ehGkBFwjybzWkR8?si=d6d587fe7439454f
The ID is **4PTG3Z6ehGkBFwjybzWkR8**
***
**How do I get a iBroadcast playlist's ID?**
Answer
***
First locate the url when your playlist is open. The playlist ID follows the ID tag within the URL and prior to the apersand (&).
Example: https://media.ibroadcast.com/?view=container&container_id=######&type=playlists
The ID is **######**
***
## Prerequisite Instructions
| [Back to install Option 1](#usage-option-1-downloadable-docker-image)
| [Back to install Option 2](#usage-option-2-creating-a-docker-image) |
**NOTE**: If using WSL on Ubuntu 22.xx, make sure to run the following commands prior to running the script (adds missing yet required tools):
```
sudo add-apt-repository ppa:wslutilities/wslu
sudo apt update
sudo apt install wslu
```
**Prerequisite: Docker**
Installing Docker
***
Detailed instructions will come in the future. Please follow the instructions here instead: https://docs.docker.com/get-docker/
**NOTE:** Docker Engine is required.
***
**Prerequisite: MP3 Manager of Your Choice**
MP3 Managers
***
If you have an Apple device, it is highly recommended you use either iBroadcast or Apple Music as your MP3 manager.
If you have an Android device, it is highly recommended you use iBroadcast.
Spotify is **not** recommended as even with your own MP3 files, Spotify still applies non-premium rules such as limited skips and ads.
Other managers may work, however, those previously mentioned have been tested with this program.
***
**Prerequisite: pip3**
Installing pip3
***
Please enter the following command into your terminal (if you are not sure if you have pip3, it is safe to run this command still):
```
sudo apt install python3-pip
```
***
## Contributing
I am not currently looking for any collaborators.