diff --git a/README.md b/README.md index ea57ca4..53b5e73 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,52 @@ # Spotify Music Downloader (SMD) Desktop | **Telegram** -# NEW DEV VERSION **HERE** (As the bot is down, you can use this CLI version) -# The SMD project is temporarily frozen due to having problems with a DMCA. + + +Spotify Music Downloader acts as a third-party platform where the user is able to interact with the GUI, Telegram, or through the command-line to download songs from Spotify, YouTube Music, and Apple Music. + [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![GitHub repo size in bytes](https://img.shields.io/github/repo-size/artyshko/smd.svg) ![GitHub Release Date](https://img.shields.io/github/release-date/artyshko/smd.svg) ![GitHub issues](https://img.shields.io/github/issues/artyshko/smd.svg) ![Beerpay](https://img.shields.io/beerpay/artyshko/smd.svg) [![Beerpay](https://beerpay.io/artyshko/smd/make-wish.svg?style=flat)](https://beerpay.io/artyshko/smd?focus=wish) - +## Table of Content +Below contains information that the user might find helpful to utilize SMD: +* [Update](#update) + * Holds important information about the current state of SMD +* [Installation](#installation) + * How to install the dependencies +* [Commands](#commands) + * The commands to run to download songs + * Shows commands for different platforms +* [Images](#images) + * Shows pictures of the GUI of different platforms + * Spotify, Telegram, CLI, etc... -

-

Desktop version GUI

-

- -. - -

-

Desktop version CLI

-

- -

-

Telegram version

-

+## Update -
+#### NEW DEV VERSION **HERE** (As the bot is down, you can use this CLI version) +#### The SMD project is temporarily frozen due to having problems with a DMCA. -
+## Installation -
+``` +git clone https://github.com/artyshko/smd.git +``` -
+#### First you have to install all dependencies +``` +pip3 install -r requirements.txt +pip3 install PyQtWebEngine +sudo apt-get install python3-pyqt5.qtwebengine +``` -
+#### Make file executable +``` +chmod +x main.py +./main.py +``` +#### Or use +``` +python3 main.py +``` -## Manual (Desktop version CLI) +#### Desktop version (CLI) ``` ./main.py [argument][value] - startup with arguments @@ -54,30 +71,38 @@ -q, --query Search query. ``` -## Installation +## Commands +### Desktop version (CLI) commands +| Command | Description | +| --- | --- | +| -h, --help | Print a help message and exit. | +| -p, --path | Set another directory. | +| -ss, --spotify-song | Spotify song link or URL. | +| -sa, --spotify-album | Spotify album link or URL. | +| -sp, --spotify-playlist | Spotify playlist URL. | +| -ds, --deezer-song | Deezer playlist link. | +| -da, --deezer-album | Deezer album link. | +| -dp, --deezer-playlist | Deezer playlist link. | +| -ym, --youtube-music | YouTube Music link. | +| -yv, --youtube-video | YouTube Video link. | +| -a, --apple | Apple Music link. | +| -q, --query | Search query. | + +#### Query mode +Example: ``` -git clone https://github.com/artyshko/smd.git +./main.py -q "The XX - Intro" ``` -### First you have to install all dependencies -``` -pip3 install -r requirements.txt -pip3 install PyQtWebEngine -sudo apt-get install python3-pyqt5.qtwebengine +#### Choose another directory +Example: ``` +./main.py -q "The XX - Intro" -p ~/Music -### Make file executable -``` -chmod +x main.py -./main.py -``` -### Or use -``` -python3 main.py +./main.py -ss "https://open.spotify.com/track/2QoDAlMnML5haTXvYRS86X" -p ~/Desktop/Music/New ``` - -### Spotify +#### Spotify Song: ``` ./main.py -ss "https://open.spotify.com/track/2QoDAlMnML5haTXvYRS86X?si=eMGX4dlwQd-7dyiG6OmUHQ" @@ -91,7 +116,7 @@ Playlist: ./main.py -sp "https://open.spotify.com/playlist/37i9dQZF1DXcRXFNfZr7Tp?si=Yd3IJQ9ATWOdFulNa7ax5g" ``` -### Deezer +#### Deezer Song: ``` ./main.py -ds "https://www.deezer.com/track/3787855" @@ -105,38 +130,36 @@ Playlist: ./main.py -dp "https://www.deezer.com/playlist/1306931615" ``` -### YouTube Music +#### YouTube Music Song: ``` ./main.py -ym "https://music.youtube.com/watch?v=HnXzzTIFu_U&list=RDAMVMHnXzzTIFu_U" ``` -### YouTube Video +#### YouTube Video Video: ``` ./main.py -yv "https://www.youtube.com/watch?v=JHi-WGFGWek" ``` -### Apple Music +#### Apple Music Example: ``` ./main.py -a "https://itunes.apple.com/us/album/i-wanna-be-yours/663097964?i=663098065" ``` -### Query mode -Example: -``` -./main.py -q "The XX - Intro" -``` +## Images -### Choose another directory -Example: -``` -./main.py -q "The XX - Intro" -p ~/Music +### Desktop version GUI + +

+ +

+ +. + +

-./main.py -ss "https://open.spotify.com/track/2QoDAlMnML5haTXvYRS86X" -p ~/Desktop/Music/New -``` -## Desktop version GUI

@@ -152,3 +175,23 @@ Example:

+ +

Desktop version CLI

+

+ +

+

Telegram version

+

+ +
+ +
+ +
+ +
+ +
+ + +