musicbucket / musicbucket-bot

A Telegram bot that helps chat users sharing and keeping track music

MusicBucket Bot

About

MusicBucket Bot is a Telegram Bot that adds features and possibility to interact with Spotify music links that users send in a chat.

Its main feature is to allow you to save links that someones shares in a Chat in a personal list. So you can easily track which music you have pending to listen to.

When an user sends a link, the bot is able to get information from a Spotify link like:

• Artist
• Album
• Track
• Genres
• Audio preview

It also integrates with Last.fm to retrieve information about your user like Now Playing.

Why Telegram?

I chose Telegram because I'm in a few groups where we share music everyday. We soon realized that the links we shared in a group were often missed. Therefore, the idea of making a tool for keeping track of the music we share started growing so I started developing this bot.

Why Spotify?

At the start the bot supported both Spotify and Deezer, but Spotify is the platform that we use mostly, so implementing new features for both platforms became complicated and I decided supporting Spotify only.

Commands

• /music [@username] Retrieves the music shared in the chat from the last week. Grouped by user. Filter by @username optionally.
• /music_from_beginning @username Retrieves the music shared in the chat from the beginning of time by an user.
• /savedlinks Retrieves a list with your saved links
• /deletesavedlinks Shows a list of buttons for deleting saved links
• /mymusic Retrieves the music that you shared in all the chats. It has to be called from a private conversation.
• /topalbums [period](7day 'default'/1month/3month/6month/12month/overall) Top Albums. Returns the Last.fm top albums of your user.
• /topartists [period](7day 'default'/1month/3month/6month/12month/overall) Top Artists. Returns the Last.fm top artists of your user.
• /toptracks [period](7day 'default'/1month/3month/6month/12month/overall) Top Tracks. Returns the Last.fm top tracks of your user.
• /np Now Playing. Returns track information about what you are currently playing in Last.fm.
• /collage [rows] [cols] [period](7day 'default'/1month/3month/6month/12month/overall) Returns a collage of your most listened albums in a period.
• /lastfmset username Sets a Last.fm username to your Telegram user.
• /stats Retrieves an user list with a links counter for the current chat.
• /help Retrieves a list of available commands and bot features.
• @music_bucket_bot artist|album|track name Search for an artist, an album or a track and send it to the chat.

Official bot => @music_bucket_bot

Screenshots

Installation

• Install pyenv and poetry
• Do poetry install inside the folder.
• Copy the .env.dist file to .env and fill the variables with your Telegram and Spotify data.
• Execute python main.py

Special thanks

To the Sonomada community and its group in Telegram (https://t.me/Sonomada_gang) where we use and test the bot actively and propose new features.

License

The content of this project is licensed under the GNU/GPLv3 license. See LICENSE file.

musicbucket-bot's Issues

Update user and chat data in the DB if it changes in Telegram

Add /genre command to list artists of this genre

Add /genre commands to return a list of most sent artists (or most populars) of this genre.

Usage example:
/genre postrock

Force filtering /music_from_beginning command by user and split too long message

Send cover image when using /np command

https://stackoverflow.com/questions/38685619/how-to-send-an-embedded-image-along-with-text-in-a-message-via-telegram-bot-api

Refactor musicbucket_bot.py

Refactor musicbucket_bot.py creating a class for every command and split large command methods into smaller ones

Add the possibility to link a Spotify playlist to a chat and read it through the bot

1. Modify the chat database model to add a playlist field.
2. Add a command that allows an url to set, for the current chat, a playlist link.
3. Add another command to retrieve the playlist for the current chat and show it in a bot message.

Unify logging names and structure

For example:

• [DATE] - [Chat] - [User] - [Class] - [Method]: Text

Add help message to /np when no Last.fm username is set to the current Telegram user

Add a help text to the /start command

Add a help text to the /start command explaining the functionality of the bot

Add genre(s) to artist/album/track information

Log exceptions

Add user information to the /savedlinks command

Refactor responser.py file

Refactor Responser class into smaller classes for every command and split the large response functions into smaller ones

Add a Spotify track preview when saving a track/album/artist

Reply with a list of genres when someone sends a link

Add screenshots to README.md

Add few screenshots of the bot usage

Last.fm integration

• Add the possibility to retrieve, with a command (/nowplaying [username] or similar) the track that a last.fm user is playing. If it's possible, send the Spotify link too.
• Add the possibility to set the last.fm username to a specific telegram user.

General refactor

1. Create a bot module in app and move responser.py inside.
2. Add a commands.py file and move in all the commands in bot.py

Database restructuration

Create Artist and Album model and a foreign key from Link to both. Save both ids and some information like name and genres
This will allow to use /recommendations basing the query to both Artist and Album and not only Artist.

Then, it will be necessary to do a migration to retrieve the data from Spotify for every album and artist.

Make logging more useful

I'll be useful to add a method decorator for logging when a command is called

Search artists/albums/tracks

Add the possibility to search artists/albums/tracks using the Spotify API.

@music_bucket_bot [name] > display a list of results and add to the chat by clicking them

Create a field or a many to many relationship in the model Link to store a username (with previous validation) if when an user sends a Spotify link, the message contains a username mentioning someone

Log to a file

Integrate Spotify Login via Flask Web API

Develop a Flask Service connected to the musicbucket_bot DB allowing users link their Spotify profile to the bot to enchange Spotify User integration

Official api not working

Hello!
The official api is not working
I cant login with telegram

Refactor user and chat creation

Refactor user and chat creation methods into new mixins to make new command classes to inherit from them

Spotify recommendations based on a chat sent links

Spotipy has a method https://spotipy.readthedocs.io/en/latest/#spotipy.client.Spotify.recommendations

Migrate ORM from SQLAlchemy to Peewee

Integrate with Google Analytics

https://github.com/dmvass/universal-analytics-python3

Migrate to Poetry

Feature for following artists

Add the feature of following artists and get notified when they release an album and showing their next releases

Classify the search as an inline and not a command

Add a command for a private conversation to list the links of all the groups you have sent

Dockerize project

Add updated_at and last_update_user fields to UserChatLink table

Add the updated_at and last_update_user fields to an already inserted link in order to avoid duplicate entries when sending a link that was already sent before.

A la hora de seguir un artista añadirlo si no existe

Cuando sigues un artista con /followartist, si todavía no se ha enviado ningún enlace del artista y por lo tanto no existe en la base de datos se debería de crear en dicho momento

Implement tests

Add genre information (like top 3 genres in a group, artist information (top 3) in /stats command

Filter /music command by user

/music@music_bucket_bot @username

Revisar dependencias de node

La dependencia node-sass lanza dos warnings:

warning node-sass > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142
warning node-sass > node-gyp > [email protected]: request has been deprecated, see https://github.com/request/request/issues/3142

Habría que mirar de actualizar la dependencia y ver si se puede eliminar request, revisar el enlace que indica en el mensaje de error.