Skip to main content

Command Line Lyrics fetcher from mpris media player like Spotify, VLC, Audacious

Project description

Lyrics-In-Terminal

GitHub release GitHub license PyPI version shields.io

Shows lyrics of songs from your favourite music player in terminal.

lyrics lyrics

Supported Players

Almost all of the mpris specification compliant media players are supported, including -

  • Spotify
  • VLC Media player
  • Rhythmbox
  • Audacious

Requirements

  • Python >= 3.6
  • dbus-python
  • curses

Installation

From PyPi

pip install lyrics-in-terminal

If pip install fails, then try installing python-dbus package from your distribution's repository first.

From Source

First install dbus-python from your distribution's repository.

Debian and Ubuntu
sudo apt install python-dbus
Arch Linux
sudo pacman -S python-dbus

Install from source

git clone https://github.com/Jugran/lyrics-in-terminal.git
cd lyrics-in-terminal
pip install . --user

Updating

Warning!: if updating from version <= 1.1, please backup your custom config file as it will be overwritten.

pip install -U lyrics-in-terminal

Usage

$ lyrics

Default player is Spotify, if you want to show lyrics from some other then pass player name as an argument

$ lyrics {playername}

$ lyrics vlc
$ lyrics audacious
$ lyrics rhythmbox

Default Keybindings

Action Keybinding
Scroll Up Up Arrow | ↑ / Mouse wheel Up
Scroll Down Down Arrow | ↓/ Mouse wheel Down
Scroll Up (5 steps) Left Arrow | ←
Scroll Down (5 steps) Right Arrow | →
Align Text Right l
Align Text Center k
Align Text Left j
Update Lyrics
(from Azlyrics)
r
Update Lyrics
(from Google)
R
Delete lyrics file d
Show Help page h
Quit Program q
  • Update Lyrics: Deletes local cached lyrics and fetches lyrics from the internet.
  • Delete Lyrics: Deletes local lyrics text file from ~/.cache/lyrics/{trackname}

Configuration

Config file is located in ~/.config/lyrics-in-terminal/lyrics.cfg

File Format

# config structure
[SECTION]
option=value

---------------------------------------------------------------
#DEFAULT OPTIONS
[OPTIONS]
alignment=left
source=google
interval=1500
player=spotify

[BINDINGS]
#scroll
up=arrow_up
down=arrow_down
step-up=arrow_left
step-down=arrow_right
step-size=5

#source switch key
google=R
azLyrics=r

#text alignment
left=j
center=k
right=l

delete=d
help=h
quit=q

License

MIT


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lyrics-in-terminal-1.2.1.tar.gz (9.4 kB view hashes)

Uploaded Source

Built Distribution

lyrics_in_terminal-1.2.1-py3-none-any.whl (11.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page