i3-gaps, polybar

.config/polybar/polybar-spotify/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jesse van Rhijn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.config/polybar/polybar-spotify/README.md

@@ -0,0 +1,70 @@
+# polybar-spotify
+
+This is a module that shows the current song playing and its primary artist on Spotify, with a Spotify-green underline, for people that don't want to set up mpd. If Spotify is not active, nothing is shown. If the song name is longer than `trunclen` characers (default 25), it is truncated and `...` is appended. If the song is truncated and contains a single opening parenthesis, the closing paranethsis is appended as well.
+
+### Dependencies
+- Python (2.x or 3.x)
+- Python `dbus` module
+
+[![sample screenshot](https://i.imgur.com/kEluTSq.png)](https://i.imgur.com/kEluTSq.png)
+
+### Settings
+``` ini
+[module/spotify]
+type = custom/script
+interval = 1
+format-prefix = " "
+format = <label>
+exec = python /path/to/spotify/script -f '{artist}: {song}'
+format-underline = #1db954
+```
+
+#### Custom arguments
+
+##### Truncate
+
+The argument "-t" is optional and sets the `trunlen`. It specifies the maximum length of the song name, so that it gets truncated when the specified length is exceeded. Defaults to 25.
+
+Override example:
+
+``` ini
+exec = python /path/to/spotify/script -t 42
+```
+
+##### Format
+
+The argument "-f" is optional and sets the format. You can specify how to display the song and the artist's name, as well as where (or whether) to print the play-pause indicator. 
+
+Override example:
+
+``` ini
+exec = python /path/to/spotify/script -f '{play_pause} {song} - {artist}'
+```
+
+This would output "Lone Digger - Caravan Palace" in your polybar, instead of what is shown in the screenshot.
+
+##### Status indicator
+
+The argument "-p" is optional, and sets which unicode symbols to use for the status indicator. These should be given as a comma-separated string, with the play indicator as the first value and the pause indicator as the second.
+
+Override example:
+
+``` ini
+exec = python /path/to/spotify/script -p '[playing],[paused]'
+```
+
+##### Fonts
+
+The argument "--font" is optional, and allow to specify which font from your Polybar config to use to display the main label.
+
+Override example:
+```ini
+exec = python /path/to/spotify/script --font=1
+```
+
+The argument "--playpause-font" is optional, and allow to specify which font from your Polybar config to use to display the "play/pause" indicator.
+
+Override example:
+``` ini
+exec = python /path/to/spotify/script -p '[playing],[paused]' --playpause-font=2
+```

.config/polybar/polybar-spotify/spotify_status.py

@@ -0,0 +1,122 @@
+#!/bin/python
+
+import sys
+import dbus
+import argparse
+
+
+parser = argparse.ArgumentParser()
+parser.add_argument(
+    '-t',
+    '--trunclen',
+    type=int,
+    metavar='trunclen'
+)
+parser.add_argument(
+    '-f',
+    '--format',
+    type=str,
+    metavar='custom format',
+    dest='custom_format'
+)
+parser.add_argument(
+    '-p',
+    '--playpause',
+    type=str,
+    metavar='play-pause indicator',
+    dest='play_pause'
+)
+parser.add_argument(
+    '--font',
+    type=str,
+    metavar='the index of the font to use for the main label',
+    dest='font'
+)
+parser.add_argument(
+    '--playpause-font',
+    type=str,
+    metavar='the index of the font to use to display the playpause indicator',
+    dest='play_pause_font'
+)
+
+
+args = parser.parse_args()
+
+def fix_string(string):
+    # corrects encoding for the python version used
+    if sys.version_info.major == 3:
+        return string
+    else:
+        return string.encode('utf-8')
+
+# Default parameters
+output = fix_string(u'{play_pause} {artist}: {song}')
+trunclen = 25
+play_pause = fix_string(u'\u25B6,\u23F8') # first character is play, second is paused
+
+label_with_font = '%{{T{font}}}{label}%{{T-}}'
+font = args.font
+play_pause_font = args.play_pause_font
+
+# parameters can be overwritten by args
+if args.trunclen is not None:
+    trunclen = args.trunclen
+if args.custom_format is not None:
+    output = args.custom_format
+if args.play_pause is not None:
+    play_pause = args.play_pause
+
+try:
+    session_bus = dbus.SessionBus()
+    spotify_bus = session_bus.get_object(
+        'org.mpris.MediaPlayer2.spotify',
+        '/org/mpris/MediaPlayer2'
+    )
+
+    spotify_properties = dbus.Interface(
+        spotify_bus,
+        'org.freedesktop.DBus.Properties'
+    )
+
+    metadata = spotify_properties.Get('org.mpris.MediaPlayer2.Player', 'Metadata')
+    status = spotify_properties.Get('org.mpris.MediaPlayer2.Player', 'PlaybackStatus')
+
+    # Handle play/pause label
+
+    play_pause = play_pause.split(',')
+
+    if status == 'Playing':
+        play_pause = play_pause[0]
+    elif status == 'Paused':
+        play_pause = play_pause[1]
+    else:
+        play_pause = str()
+
+    if play_pause_font:
+        play_pause = label_with_font.format(font=play_pause_font, label=play_pause)
+
+    # Handle main label
+
+    artist = fix_string(metadata['xesam:artist'][0]) if metadata['xesam:artist'] else ''
+    song = fix_string(metadata['xesam:title']) if metadata['xesam:title'] else ''
+
+    if not artist and not song:
+        print('')
+    else:
+        if len(song) > trunclen:
+            song = song[0:trunclen]
+            song += '...'
+            if ('(' in song) and (')' not in song):
+                song += ')'
+
+        if font:
+            artist = label_with_font.format(font=font, label=artist)
+            song = label_with_font.format(font=font, label=song)
+
+        print(output.format(artist=artist, song=song, play_pause=play_pause))
+
+except Exception as e:
+    if isinstance(e, dbus.exceptions.DBusException):
+        print('')
+    else:
+        print(e)