add help page which shows keybindings

goktug97 · Dec 19, 2019 · fd848a5 · fd848a5
1 parent f095240
commit fd848a5
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,7 @@ spotify-lyrics
 | Next          | <kbd>n</kbd> |
 | Prev          | <kbd>p</kbd> |
 | Update Lyrics | <kbd>d</kbd> |
+| Help          | <kbd>h</kbd> |
 | Quit Program  | <kbd>q</kbd> |
 
 - Edit Lyrics: Open lyrics in `$EDITOR`.
@@ -51,6 +52,7 @@ spotify-lyrics
 - Next: Play next song.
 - Prev: Play previous song.
 - Update Lyrics: Deletes cached lyrics and fetches lyrics from the internet. 
+- Help: Show keybindings 2 seconds.
 
 ### Example Use Case (i3wm)
 ```i3

diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@
     long_description = f.read()
 
 setup(name='yet-another-spotify-lyrics',
-      version='2.1.1',
+      version='2.2.1',
       description='Command Line Spotify Lyrics with Album Cover',
       author='Göktuğ Karakaşlı',
       author_email='karakasligk@gmail.com',
@@ -17,7 +17,7 @@
       long_description_content_type='text/markdown',
       url='https://github.com/goktug97/yet-another-spotify-lyrics',
       download_url=(
-          'https://github.com/goktug97/yet-another-spotify-lyrics/archive/v2.1.1.tar.gz'),
+          'https://github.com/goktug97/yet-another-spotify-lyrics/archive/v2.2.1.tar.gz'),
       py_modules=[os.path.splitext(os.path.basename(path))[0]
                   for path in ['spotify_lyrics',
                                'utils',

diff --git a/spotify_lyrics.py b/spotify_lyrics.py
@@ -170,6 +170,15 @@ def main(self, canvas):
                     self.spotify.prev()
                 elif key == 't':
                     self.spotify.toggle()
+                elif key == 'h':
+                    os.system('clear')
+                    album_cover.visibility = ueberzug.Visibility.INVISIBLE
+                    utils.move_cursor(0, start_row)
+                    utils.print_help()
+                    time.sleep(2)
+                    self.print_metadata()
+                    album_cover.visibility = ueberzug.Visibility.VISIBLE
+
 
 def main():
     Lyrics().main()

diff --git a/utils.py b/utils.py
@@ -91,3 +91,26 @@ def prev(self):
 
     def toggle(self):
         self.player_interface.PlayPause()
+
+def print_help():
+    print(boldify('''
+| Action        | Keybinding   |
+|:-------------:|:------------:|
+| Scrool Up     |      k       |
+| Scrool Down   |      j       |
+| Edit Lyrics   |      e       |
+| Refresh       |      r       |
+| Toggle        |      t       |
+| Next          |      n       |
+| Prev          |      p       |
+| Update Lyrics |      d       |
+| Help          |      h       |
+| Quit Program  |      q       |
+
+- Edit Lyrics: Open lyrics in `$EDITOR`.
+- Refresh: Refresh lyrics and song metadata.
+- Toggle: Play or Pause currently playing song.
+- Next: Play next song.
+- Prev: Play previous song.
+- Update Lyrics: Deletes cached lyrics and fetches lyrics from the internet.
+- Help: Show keybindings 2 seconds.'''))