https://github.com/surfboardv2ray/telegram-spotbot

A simple bot to use Spotify features in Telegram.
https://github.com/surfboardv2ray/telegram-spotbot

github-actions spotdl spotify spotify-downloader telegram telegram-bot

Last synced: 2 days ago
JSON representation

A simple bot to use Spotify features in Telegram.

• Host: GitHub
• URL: https://github.com/surfboardv2ray/telegram-spotbot
• Owner: Surfboardv2ray
• License: apache-2.0
• Created: 2024-05-16T11:16:23.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T04:26:55.000Z (6 months ago)
• Last Synced: 2024-05-22T05:25:59.412Z (6 months ago)
• Topics: github-actions, spotdl, spotify, spotify-downloader, telegram, telegram-bot
• Language: Python
• Homepage: https:/t.me/Surfboardv2ray
• Size: 45.9 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Introduction

A simple bot to get Spotify's features in Telegram.

# Disclaimer

This code is developed for educational purposes only and no abuse of any services, either Github, Spotify, or Telegram is instended.

# How to

* Create a telegram bot using [@BotFather](https://t.me/BotFather) and get your bot API token.

* Create an Actions Secret called `TELEGRAM_BOT_TOKEN` and set the value as your bot API token.

* Make sure you've allowed `Read and Write Permission` to github actions before running the workflow.

* To avoid extended workflow run for free users and avoid abuse of services, `tg-bot.yml` is set out to cancel the workflow after a limited time. Adjust it under `timeout-minutes`, capped at 6 hours due to Github policies (360 minutes).

* Run the workflow and `/start` your Telegram bot.

# Running Locally

* Resources to run locally are available under [Releases](https://github.com/Surfboardv2ray/telegram-spotbot/releases).

* Install dependencies via `requirements.txt`.

* Edit `tg-bot.py` and replace `YOUR_BOT_TOKEN` with your bot API Token.

* Run the script and `/start` your Telegram bot.

# Advanced

* Current version of the bot only supports Spotify links. However, to use search the function, you're also gonna need `SPOTIFY_CLEINT_ID` and `SPOTIFY_CLIENT_SECRET`.

* That's why we added the source code with search ability under `advanced` folder to keep the main code simple.

* Steps:

  * Create a spotify account, then [Create a Spotify App](https://developer.spotify.com/dashboard/create).

  * Get your Spotify Client ID and Client Secret and put them in your Github Actions Secrets.

  * Use the Github action workflow and python script inside the `advanced` directory. Make sure you've set `TELEGRAM_BOT_TOKEN` in your secrets as well.

  * If running locally, you could simply hard-code the three environment variables right inside the python script.