swaglyrics-backend's Introduction

swaglyrics-backend

Server side code to make an issue on the main repo when the program encounters a song it can't fetch lyrics for.

Works using the GitHub API and Flask.

The main program is configured to send a POST request to the server.

Need to document and add unit testing.

Rate Limits

In order to prevent spam and/or abuse of endpoints, rate limiting has been set such that it wouldn't affect a normal user.

Since SwagLyrics checks for track change every 5 seconds, requests on endpoints /stripper and /unsupported are allowed once per 5 seconds only.

Contributors

Stargazers

Watchers

swaglyrics-backend's Issues

Discord message whenever backend deployed

Configure webhook handling for it.

Maybe use rich embed https://discordapp.com/developers/docs/resources/webhook#execute-webhook

Create template for homepage

Something similar to the swaglyrics -t template in looks should be nice.
https://github.com/SwagLyrics/SwagLyrics-For-Spotify/blob/master/swaglyrics/templates/lyrics.html

A brief description of the backend to go at the top would be useful as well.

Return message when song is determined instrumental

Return a message to the user from the API when a song is determined to be instrumental by the spotify analysis API.

This should help with debugging of the instrumentality analysis feature.

Auto delete song/artist from master unsupported.txt if issue closed

Needs webhook trickery

Do not create an issue for trivial cases

For example, if the song and artist do not contain any special characters and are simple words, there's a super minimal chance that we're doing something wrong and a bigger chance that that track doesn't have lyrics available on Genius. In this case, an issue should not be created and the appropriate info should be returned to the user.

This should be incorporated into the backend.