ConkLyr

An awesome Conky widget that prints the lyrics of the currently played song

Table of Contents

1. About The Project
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. Issues

About The Project

Have you ever listen to a song and wondered "What are the lyrics???" but you were too lazy to search them?

If so, that is a conky widget for you.

This script connects to your Spotify account (you'll need to generate api credentials) and searches for the lyrics using the Genius api (you'll need to register for that api as well - super fast & easy).

Once connected the lyrics will appear on the conky widget - scrolling along with the song and highlighting segment titles.

Getting Started

Installation

Install Conky in your machine.

Now you will need to create your own API credentials with both Spotify and Genius in the following links:

1. Spotify - Get a free API Key at developer.spotify.com/dashboard/login
2. Genius - Get a free API Key at docs.genius.com/

After completing the API registration, you'll need to run:

git clone https://github.com/yarinbar/conklyr.git
cd conklyr
pip install -r requirements.txt

In this script we install the following:

numpy
matplotlib
spotipy==2.19.0
lyricsgenius==3.0.1

After installing requirements.txt you are basically done.

Usage

assuming your shell is in the folder conklyr:

export CLIENT_ID=YOUR_SPOTIFY_CLIENT_ID
export CLIENT_SECRET=YOUR_SPOTIFY_CLIENT_SECRET
export GENIUS_TOKEN=YOUR_GENIUS_TOKEN
conky -c lyrics.conf

note that if you dont want to export it each session, you can add it to your .bashrc or .zshrc.

you can edit lyrics.conf arguments and also the arguments used by the 'lyrics.py' script to personalize the widget.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch
3. Commit your Changes
4. Push to the Branch
5. Open a Pull Request

Issues

These are the issues I have noticed so far:

1. changing the background (in the .conf file) color to anything other than #000000 cant be transparent - I opened an issue on this one here
2. right-to-left is not aligned
3. sometimes the last lines of the lyrics ends with a number
4. sometimes empty lines are removed for no apparent reason

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name