Lyrics Bot for Telegram

This is a Telegram bot which is able to find lyrics to a song and print it out for the user. It uses Telethon which is a pure Python 3 MTProto API Telegram client library. Lyrics are retrieved from azlyrics.com by web scraping method. azlyrics.py is a modified file that is inspired from adhorrig/azlyrics

My own version is KasetLyricsBot, free for all.

Commands / Options

1. /help - Prints out the help text
2. /start - Starts the bot
3. /stop - Stops the bot
4. Lyrics of a song - After this option, user must enter both artist and song spelled correctly to get the lyrics of it directly. Name of the artist and song should be separated with an hyphen (-).
   Example input: Oasis - Don't Look Back in Anger

5. Search by lyrics - After this option, user must enter the lyrics that he/she remembers partially. If only one result with these lyrics found, then it will be printed out. If multiple results are found, first five result will be printed out and user will choose the correct one if it is listed. If it is not listed, user may proceed with the next five results and so on.
6. Songs of artist - After this option, user must enter the name of the artist to retrieve all songs of belonging to it. Only songs that have lyrics on the database will be shown. Songs will be listed under the album it belongs to.
7. Albums of artist - After this option, user must enter the name of the artist to retrieve the album names that have songs with lyrics in them.

TODO

• Use menu (buttons) options instead of commands.
• Lyrics of a song
• Search by lyrics
  • Search request for other pages if the song is not found in the first page. (First page returns 20 results.)
• Songs of artist
• Albums of artist
• Fix MessageTooLongError where messages longer than 4096 characters can not be sent.
• Better logging mechanism.
• Print the Spotify link of the song after the request.
• Find by Spotify link: User pastes the link and lyrics are displayed.
• Delete Me option, where the user can delete his/her sender_id from conversation_state array.
• Add exception if status code is 200 but captcha challenge requested from server.
• Add "Cancel" option to other menu options.

If the number of users increases, a database might be used to store conversation_state for each user.

Requirements for Development

To install the requirements, run:

pip3 install -r requirements.txt

You can prepare a file called exportapi.sh to easily export your API information for continuous development. An example is in below:

export TG_SESSION_NAME=nameOfYourSession
export TG_API_ID=1234567
export TG_API_HASH=yourPers0nalApiHashThatY0uG3tFr0mTelegram
export TG_BOT_TOKEN=1234567890:yourB0tTokenThatY0uG3tFr0mBotFather

To export this in your current shell, run chown 700 exportapi.sh && source exportapi.sh

Command List to send to the BotFather

Below is the command list that you can send to the BotFather. This is done for the users that are going to use your bot.

help - See how to use this bot
start - Start the bot
stop - Stop the bot

Run

python3 kasetlyricsbot.py

Docker Deployment

There are Dockerfile and docker-compose-example.yml files for easy deployment. Change the environment variables inside example compose file and rename it as docker-compose.yml. You can use the following command to build and run the bot.

docker compose up -d --build