├── LICENSE
├── README.md
└── spotify_status.py


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


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # polybar-spotify
 2 | 
 3 | 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.
 4 | 
 5 | ### Controls
 6 | 
 7 | You can add mouse controls for the player inside the module, as well. The configuration shown below uses mouse-1 for play-pause, mouse-2 for next, and mouse-3 for previous.
 8 | 
 9 | ### Dependencies
10 | - Python (2.x or 3.x)
11 | - Python [`dbus`](https://pypi.org/project/dbus-python/) module
12 | - playerctl
13 | 
14 | [![sample screenshot](https://i.imgur.com/kEluTSq.png)](https://i.imgur.com/kEluTSq.png)
15 | 
16 | ### Settings
17 | ``` ini
18 | [module/spotify]
19 | type = custom/script
20 | interval = 1
21 | format-prefix = " "
22 | format = <label>
23 | exec = python /path/to/spotify/script -f '{artist}: {song}'
24 | format-underline = #1db954
25 | ;control players (optional)
26 | click-left = playerctl --player=spotify play-pause 
27 | click-right = playerctl --player=spotify next 
28 | click-middle = playerctl --player=spotify previous 
29 | ```
30 | 
31 | #### Custom arguments
32 | 
33 | ##### Truncate
34 | 
35 | The argument "-t" is optional and sets the `trunlen`. It specifies the maximum length of the printed string, so that it gets truncated when the specified length is exceeded. Defaults to 35.
36 | 
37 | Override example:
38 | 
39 | ``` ini
40 | exec = python /path/to/spotify/script -t 42
41 | ```
42 | 
43 | ##### Format
44 | 
45 | 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. 
46 | 
47 | Override example:
48 | 
49 | ``` ini
50 | exec = python /path/to/spotify/script -f '{play_pause} {song} - {artist} - {album}'
51 | ```
52 | 
53 | This would output "Lone Digger - Caravan Palace - <I°_°I>" in your polybar, instead of what is shown in the screenshot.
54 | 
55 | ##### Status indicator
56 | 
57 | 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.
58 | 
59 | Override example:
60 | 
61 | ``` ini
62 | exec = python /path/to/spotify/script -p '[playing],[paused]'
63 | ```
64 | 
65 | ##### Fonts
66 | 
67 | The argument "--font" is optional, and allow to specify which font from your Polybar config to use to display the main label.
68 | 
69 | Override example:
70 | ```ini
71 | exec = python /path/to/spotify/script --font=1
72 | ```
73 | 
74 | The argument "--playpause-font" is optional, and allow to specify which font from your Polybar config to use to display the "play/pause" indicator.
75 | 
76 | Override example:
77 | ``` ini
78 | exec = python /path/to/spotify/script -p '[playing],[paused]' --playpause-font=2
79 | ```
80 | 
81 | ##### Quiet
82 | 
83 | The argument "-q" or "--quiet" is optional and specifies whether to display the output when the current song is paused.
84 | This will make polybar only show a song title and artist (or whatever your custom format is) when the song is actually playing and not when it's paused.
85 | Simply setting the flag on the comand line will enable this option.
86 | 
87 | Override example:
88 | ```ini
89 | exec = python /path/to/spotify/script -q
90 | ```
91 | 


--------------------------------------------------------------------------------
/spotify_status.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | 
  3 | import sys
  4 | import dbus
  5 | import argparse
  6 | 
  7 | parser = argparse.ArgumentParser()
  8 | parser.add_argument(
  9 |     '-t',
 10 |     '--trunclen',
 11 |     type=int,
 12 |     metavar='trunclen'
 13 | )
 14 | parser.add_argument(
 15 |     '-f',
 16 |     '--format',
 17 |     type=str,
 18 |     metavar='custom format',
 19 |     dest='custom_format'
 20 | )
 21 | parser.add_argument(
 22 |     '-p',
 23 |     '--playpause',
 24 |     type=str,
 25 |     metavar='play-pause indicator',
 26 |     dest='play_pause'
 27 | )
 28 | parser.add_argument(
 29 |     '--font',
 30 |     type=str,
 31 |     metavar='the index of the font to use for the main label',
 32 |     dest='font'
 33 | )
 34 | parser.add_argument(
 35 |     '--playpause-font',
 36 |     type=str,
 37 |     metavar='the index of the font to use to display the playpause indicator',
 38 |     dest='play_pause_font'
 39 | )
 40 | parser.add_argument(
 41 |     '-q',
 42 |     '--quiet',
 43 |     action='store_true',
 44 |     help="if set, don't show any output when the current song is paused",
 45 |     dest='quiet',
 46 | )
 47 | 
 48 | args = parser.parse_args()
 49 | 
 50 | 
 51 | def fix_string(string):
 52 |     # corrects encoding for the python version used
 53 |     if sys.version_info.major == 3:
 54 |         return string
 55 |     else:
 56 |         return string.encode('utf-8')
 57 | 
 58 | 
 59 | def truncate(name, trunclen):
 60 |     if len(name) > trunclen:
 61 |         name = name[:trunclen]
 62 |         name += '...'
 63 |         if ('(' in name) and (')' not in name):
 64 |             name += ')'
 65 |     return name
 66 | 
 67 | 
 68 | 
 69 | # Default parameters
 70 | output = fix_string(u'{play_pause} {artist}: {song}')
 71 | trunclen = 35
 72 | play_pause = fix_string(u'\u25B6,\u23F8') # first character is play, second is paused
 73 | 
 74 | label_with_font = '%{{T{font}}}{label}%{{T-}}'
 75 | font = args.font
 76 | play_pause_font = args.play_pause_font
 77 | 
 78 | quiet = args.quiet
 79 | 
 80 | # parameters can be overwritten by args
 81 | if args.trunclen is not None:
 82 |     trunclen = args.trunclen
 83 | if args.custom_format is not None:
 84 |     output = args.custom_format
 85 | if args.play_pause is not None:
 86 |     play_pause = args.play_pause
 87 | 
 88 | try:
 89 |     session_bus = dbus.SessionBus()
 90 |     spotify_bus = session_bus.get_object(
 91 |         'org.mpris.MediaPlayer2.spotify',
 92 |         '/org/mpris/MediaPlayer2'
 93 |     )
 94 | 
 95 |     spotify_properties = dbus.Interface(
 96 |         spotify_bus,
 97 |         'org.freedesktop.DBus.Properties'
 98 |     )
 99 | 
100 |     metadata = spotify_properties.Get('org.mpris.MediaPlayer2.Player', 'Metadata')
101 |     status = spotify_properties.Get('org.mpris.MediaPlayer2.Player', 'PlaybackStatus')
102 | 
103 |     # Handle play/pause label
104 | 
105 |     play_pause = play_pause.split(',')
106 | 
107 |     if status == 'Playing':
108 |         play_pause = play_pause[0]
109 |     elif status == 'Paused':
110 |         play_pause = play_pause[1]
111 |     else:
112 |         play_pause = str()
113 | 
114 |     if play_pause_font:
115 |         play_pause = label_with_font.format(font=play_pause_font, label=play_pause)
116 | 
117 |     # Handle main label
118 | 
119 |     artist = fix_string(metadata['xesam:artist'][0]) if metadata['xesam:artist'] else ''
120 |     song = fix_string(metadata['xesam:title']) if metadata['xesam:title'] else ''
121 |     album = fix_string(metadata['xesam:album']) if metadata['xesam:album'] else ''
122 | 
123 |     if (quiet and status == 'Paused') or (not artist and not song and not album):
124 |         print('')
125 |     else:
126 |         if font:
127 |             artist = label_with_font.format(font=font, label=artist)
128 |             song = label_with_font.format(font=font, label=song)
129 |             album = label_with_font.format(font=font, label=album)
130 | 
131 |         # Add 4 to trunclen to account for status symbol, spaces, and other padding characters
132 |         print(truncate(output.format(artist=artist, 
133 |                                      song=song, 
134 |                                      play_pause=play_pause, 
135 |                                      album=album), trunclen + 4))
136 | 
137 | except Exception as e:
138 |     if isinstance(e, dbus.exceptions.DBusException):
139 |         print('')
140 |     else:
141 |         print(e)
142 | 


--------------------------------------------------------------------------------