Skip to content
master
Go to file
Code

README.md

SwagLyricsSwagLyrics-For-Spotify

Discord Server Build Status Build Status PyPI Arch User Repository Downloads

Fetches the currently playing song from Spotify on Windows, Linux and macOS and displays the lyrics in the command-line, browser tab or in a desktop application. Refreshes automatically when song changes. The lyrics are fetched from Genius. Turns out Deezer already has this feature in-built but with swaglyrics, you can have it in Spotify as well.

I'm mainly trying to build this project as far as I can, for practice and to learn and work with more technologies and platforms.

Initially developed this for personal use. Pretty much functionality oriented -- I usually develop something that I can see helping me and other users in the same situation. Packaged so I can first hand handle production-ready code to an extent and to make distribution and usage easier.

Why SwagLyrics?

SwagLyrics is the fastest and the most accurate package for getting lyrics.1

Provided optimal internet, SwagLyrics can fetch lyrics for a track in as less as 0.28s.2

It also does not require the user to generate any sort of API token (Spotify or Genius) and serves functionality right off the bat. This is possible as the song identification is done using our in-house library SwSpotify which does it locally for all operating systems.

The enhanced user experience is possible due to the backend which manages creating issues for unsupported songs and then adding support for them where possible by employing various techniques. Any song with lyrics on Genius can be supported without any user interaction owing to the backend. If say, lyrics do not exist for a track then subsequent playings of that track will not waste your resources in trying to fetch lyrics, this is done by a master list of unsupported songs which is handled by the backend as well.

1. [results] Tested against LyricsGenius, the most popular similar package on the US Top 50 Chart on Spotify. SwagLyrics was fractionally more accurate and 2.4x times faster. ↩
2. [results] Speed and accuracy benchmark using Google Colab on the Spotify US Top 50 chart. ↩

Installation

Requires Python 3.6+. Use pip or pip3 depending on your installation. You might want to use the --user flag on Linux to avoid using pip as root.

pip install swaglyrics

Arch Linux

Arch Linux users can directly install SwagLyrics from AUR (swaglyricsAUR). Using yay:

yay -S swaglyrics

Nix

Nix users on any Linux distro and NixOS can install SwagLyrics from Nixpkgs.

nix-env -i swaglyrics

Usage

usage: swaglyrics [-h] [-t] [-c] [-n]

Either the tab or cli argument is required to output lyrics.

Arguments:

  -h, --help      show this help message and exit       
  -t, --tab       Display lyrics in a browser tab.      
  -c, --cli       Display lyrics in the command-line.   
  -n, --no-issue  Disable issue-making on cli.

You can quit by pressing Ctrl+C.

Before using, you should check USING.txt to comply with the Genius ToS. There's a copy included inside the package as well.

Note: If you have trouble displaying Japanese/Chinese characters on the command-line, simply type chcp 936 to change your code page. List of code pages can be found here: https://en.wikipedia.org/wiki/Code_page

Community

Changelog

  • v1.2.0

    • Add Genius A/B support
    • Add support for Bollywood songs
    • Add update check only once per 24h
    • Add parameter to force update check

See CHANGES.md for prior release notes.

Compiling SwagLyrics for Development

  • Clone the repo by git clone https://github.com/SwagLyrics/SwagLyrics-For-Spotify.git or use ssh.
  • cd into the cloned repo.
  • pip install -e . the -e flag installs it locally in editable mode.

Improvements Planned

  1. Linux and macOS support done
  2. Better logging of unsupported songs, the isolated unsupported.txt is sub-optimal for multiple users since the file will only update locally with songs which worked fine when it was just me but since I hope others use it too, I'll try to add a better method with server support.
  3. Better tests to test all of the functionality. (cli.py fully tested!) 100% code coverage
  4. Perhaps a tiny app using Electron that could fit in your tray to be opened whenever you want lyrics for a song.
  5. Supporting more songs, currently the program sometimes fails at remixes since while the lyrics are same as original, the artist is the remixer. done
  6. Documenting all the files.

SwagLyrics on Windows with Terminal

SwagLyrics with Hyper

SwagLyrics on Windows with Firefox Side-View

SwagLyrics with Side-View

Screencast - SwagLyrics on Linux

Watch the video

Screencast - SwagLyrics on macOS

Watch the video

You can’t perform that action at this time.