CCExtractor Development

SwagLyrics: Disable issue-making for trivial song, artist pairs

Introduction

SwagLyrics is an application that fetches the currently playing song from Spotify on Windows, Linux and macOS and displays the lyrics in the command-line or in a browser tab (using Flask). Refreshes automatically when song changes and uses lyrics fetched from Genius. The application is also available as a pip module.

Whenever a song, artist pair is encountered for which lyrics cannot be fetched, a GitHub issue is created by the backend so we can figure out what went wrong and use that info to improve the application logic. This rapid iteration has served us well to get the product better, faster.

The application has recently gone stable, that means most songs are supported as long as the lyrics exist on our provider. So now we do not need to make an issue for trivial cases since that simply means that lyrics are unavailable on the provider and not a fault with an application.

The Task

In the backend code, you need to add a regular expressions filter that checks if the song and artist are only letters and spaces (no punctuation) and if that is the case, the backend doesn't log an issue for that song and returns the appropriate info back to the user.

Requirements to complete this task

We expect an opened pull request, which contains the modification requested above, unit tests that cover (most of) the changes, and documentation where necessary.

Relevant extra links

Task tags

  • swaglyrics
  • regex
  • backend
  • githubissue
  • python

Students who completed this task

Sam P

Task type

  • code Code
close

2019