Skip to content

XPL0Z/spotish

Repository files navigation

Contributors Forks Stargazers Issues


Logo

Spotish

Telegram bot to play music
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Demo
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

What is Spotish ?

Spotish is a telegram bot to play spotify link on speaker !

(back to top)

Demo


For more examples, please refer to the /start or below.

Small Doc

Available commands:
/start - 📜 Show this menu
/play <Spotify URL> - ▶️ Play a song or ➕ add it to the queue
/playtop <Spotify URL> - ⬆️ Add a track to the top of the queue
/random - 🎲 Play a random song that is already download
/pause - ⏸️ Pause the current song
/resume - 🔄 Resume the paused song
/skip - ⏭️ Skip the current song
/stop - 🛑 Stop playback and 🧹 clear the queue
/volume <0-100> - 🔊 Adjust the volume
/adduser <username> - ➕ Add an authorized user (without @)
/search <track name> - 🔍 Search and play a track by name
/mix - ♾️ play recommendation from history
/download <Spotify URL> - 💾 Download a song or a playlist
/adduser <username> <duration> <unit> - ➕ Add an authorized user
/isauthorize - ❓ Checks if someone is authorize. If there is no argument you are checking yourself. Don't put @
/queue <index> - 📋 Get future songs to play
/shuffle - 🎲 randomize the queue
/delete <song_id> - 🗑️ To delete a song from queue

(back to top)

Built With

  • Python

(back to top)

Getting Started

Prerequisites

  • Before you begin installing the project, you must first have installed Python on your machine. Otherwise, follow the instructions below.

Installing Python

On Ubuntu/Debian
  1. Open a terminal.
  2. Update the package list:
sudo apt update
  1. Install Python:
sudo apt install python3
  1. Verify the installation:
python3 --version

You should see a version number appear, for example:

Python 3.10.12

On macOS
  1. Open a terminal.
  2. Install Homebrew if you haven't already done so.
  3. Install Python with Homebrew:
brew install python
  1. Check the installation:
python3 --version

You should get something like this:

Python 3.11.8

On Windows
  1. Go to the official website python.org/downloads.
  2. Download the installer for the latest version of Python.
  3. Important: Check the “Add Python to PATH” box during installation.
  4. Complete the installation by following the instructions.
  5. Open the command prompt and verify the installation:
python --version

You should see:

Python 3.11.8

Installation of Spotish and his dependencies

  1. Download Spotish
  git clone https://github.com/XPL0Z/spotish.git
  1. Enter the directory
  cd spotish
  1. Create an virtual environnement
  python -m venv .venv
  1. Activate the virtual environnement
  source .venv/bin/activate
  1. Install requirements
  pip install -r requirements.txt
  1. Rename Example.env to .env
  2. Get a token bot at @Botfather
  3. Get a spotify ClientID and SecretID here
  4. Place your token bot, ClientID, SecretID and your username in the .env. You can add multiple user, you need to split usernames by a space
  5. Rename example-Songinfos.json to Songinfos.json
  6. Rename example-authorize.json to authorize.json
  7. Set the time between each check for update in the .env (recommended 3600)
  8. Launch run.py
  python run.py

(back to top)

---

Features

  • Play
    • Spotify
      • Songs
      • Playlist
  • Playtop
  • Pause
  • Resume
  • Skip
  • Stop
  • Volume
  • Queuing system
  • Authorized User

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

if you find a bug please fork the repo and create a pull request. You can also simply open an issue with the tag "bug" and priority tag. Don't forget to give the project a star! Thanks again!

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Top contributors:

contrib.rocks image

License

Distributed under the project_license. See LICENSE.txt for more information.

(back to top)

Contact

XPL0Z - Contact me on Telegram

Share the Project Link: spotish !

(back to top)

(back to top)

About

Download spotify song and play it on hp. You can remote with telegram

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published