Supports Waybar and Forces Config to standard locations (0.4.0) (#22) (#23) (#24)

* Forces config to sane ~/.config location.

* Updates install docs.

* Updates docs to support Waybar.

Author: conor-f

README.md

@@ -1,7 +1,7 @@
 # Spotibar
 
-  Polybar plugin for Spotify that uses the Spotify Web API. Note that this
-requires a Spotify premium account.
+  Polybar/Waybar plugin for Spotify that uses the Spotify Web API. Note that
+  this requires a Spotify premium account.
 
 ## Features:
   - [x] Display currently playing artist/song
@@ -15,7 +15,7 @@ requires a Spotify premium account.
 ![spotibar_Closed](https://user-images.githubusercontent.com/2671067/111181789-3aa6b000-85a6-11eb-8511-da536700438a.png)
 
 ## Usage/Experience:
-  After installing and configuring `spotibar` to run on your Polybar as
+  After installing and configuring `spotibar` to run on your status bar as
 described below, you should see the currently playing track/artist, interactive
 controls to go to the previous song, play/pause and go to the next track. The
 thing that justifies the little bit of extra work to set up this module is in
@@ -31,16 +31,17 @@ options.
 
   Secondly, you need to install `spotibar` and run it's `init` processes:
 ```
-python3 -m pip install spotibar
+pipx install spotibar
 spotibar --init
 ```
 
   During this install process, you will be directed to open a browser to allow Spotibar interact with your Spotify account. After accepting this, you will be redirected to a URL beginning with `http://127.0.0.1`. Copy this whole URL and paste it back into the init process when asked!
 
   If you're getting errors, try removing spotibar and reinstalling under sudo permissions. If you get an error involving `libtk8.6.so`, install tk using your distro's package manager.
 
-  Once `spotibar` is installed and authenticated, you need to modify your
-polybar config as follows (or however suits your needs!):
+  Once `spotibar` is installed and authenticated, you need to modify your status bar config as follows (or however suits your needs!):
+
+### Polybar:
 ```
 modules-right = <other modules> spotibar-currently-playing spotibar-previous-track spotibar-toggle-playback spotibar-next-track spotibar-add-to-playlist <other modules>
 
@@ -84,6 +85,51 @@ click-right = spotibar --config-popup
 exec-if = [ $(spotibar --is-live) = "True" ]
 format-underline = #1db954
 format-padding = 2
+```
+
+### Waybar:
+Note that this relies on `mediaplayer.py` to output the currently playing track. This behaviour can easily be modified (e.g. by using `spotibar --get-currently-playing`)
+
+```
+"modules-center": ["custom/media", "custom/media-skip-backward", "custom/media-play-pause", "custom/media-skip-forward"],
+
+"custom/media": {
+  "format": "{icon}   {}",
+  "return-type": "json",
+  "max-length": 40,
+  "format-icons": {
+    "spotify": "",
+    "default": "🎜"
+  },
+  "escape": true,
+  "exec": "$HOME/.config/waybar/mediaplayer.py 2> /dev/null",
+  "on-click-right": "spotibar --add-track-to-monthly-playlist"
+},
+
+"custom/media-play-pause": {
+  "format": "<span size='20pt'>\udb81\udc0e</span>",
+  "on-click": "playerctl play-pause",
+},
+"custom/media-skip-backward": {
+  "format": "<span size='20pt'>\udb81\udcab</span>",
+  "on-click": "playerctl previous",
+},
+"custom/media-skip-forward": {
+  "format": "<span size='20pt'>\udb81\udcac</span>",
+  "on-click": "playerctl next",
+},
+
+```
+
+You should also modify your `~/.config/waybar/styles.css` to style the buttons added above. e.g.
+
+```
+#custom-media-skip-backward,
+#custom-media-play-pause,
+#custom-media-skip-forward {
+    padding: 0 6px;
+    color: #ffffff;
+}
 ```
 
   Done! Enjoy! File (probably inevitable) bug reports as issues!

setup.py

@@ -1,25 +1,15 @@
-from setuptools import (
-    find_packages,
-    setup
-)
+from setuptools import find_packages, setup
 
-INSTALL_REQUIRES = [
-    'pylast',
-    'spotipy'
-]
+INSTALL_REQUIRES = ["pylast", "spotipy"]
 
 setup(
-    name='spotibar',
-    description='Spotify plugin for Polybar',
-    version='0.3.12',
-    url='https://github.com/conor-f/spotibar',
-    python_requires='>=3.6',
-    packages=find_packages('src'),
-    package_dir={'': 'src'},
+    name="spotibar",
+    description="Spotify plugin for Polybar",
+    version="0.4.0",
+    url="https://github.com/conor-f/spotibar",
+    python_requires=">=3.6",
+    packages=find_packages("src"),
+    package_dir={"": "src"},
     install_requires=INSTALL_REQUIRES,
-    entry_points={
-        'console_scripts': [
-            'spotibar = spotibar.client:main'
-        ]
-    }
+    entry_points={"console_scripts": ["spotibar = spotibar.client:main"]},
 )

src/spotibar/client.py

@@ -14,16 +14,12 @@
 
 class SpotibarClient:
     def __init__(self, *args, **kwargs):
-        """
-        :kwarg config_file: String path relative to ~/ of a config file to load.
-        """
+        """ """
         self.scope = "playlist-read-private playlist-modify-private user-read-playback-state user-modify-playback-state playlist-modify-public"
 
-        self.config_file = kwargs.get("config_file")
-
-        if not self.config_file:
-            raise Exception("A config_file must be passed.")
+        os.makedirs("~/.config/spotibar/", exist_ok=True)
 
+        self.config_file = "~/.config/spotibar/default.json"
         self.config = SpotibarConfig(config_file=self.config_file)
 
         self.client_id = self.config.get("client_id", kwargs.get("client_id", None))
@@ -36,13 +32,7 @@ def __init__(self, *args, **kwargs):
 
         self.redirect_uri = "http://127.0.0.1"
 
-        self.auth_cache = self.config.get(
-            "auth_cache_path", kwargs.get(
-                "auth_cache_path", "~/.spotibar_cache/auth_cache"
-            )
-        )
-
-        os.makedirs(os.path.dirname(self.auth_cache), exist_ok=True)
+        self.auth_cache = "~/.cache/spotibar/auth_cache"
 
         self.client = None
         self.lastfm_client = None
@@ -64,7 +54,7 @@ def get_client(self):
                 client_id=self.client_id,
                 client_secret=self.client_secret,
                 redirect_uri=self.redirect_uri,
-                cache_path=self.auth_cache,
+                cache_path=os.path.expanduser(self.auth_cache),
                 open_browser=False,
             )
         )
@@ -376,26 +366,16 @@ def first_run():
     response = input("\tSpotify client secret: ")
     config["client_secret"] = response
 
-    print("Where should we write this config?")
-    response = input("\tFilepath: [~/.spotibar_config.json] ")
-
-    config_filepath = "~/.spotibar_config.json" if response == "" else response
-
-    print("Where should we cache your authentication tokens?")
-    response = input("\tFilepath: [~/.spotibar_auth_cache] ")
-
-    auth_filepath = "~/.spotibar_auth_cache" if response == "" else response
-
     spotibar_client = SpotibarClient(
         client_id=config["client_id"],
         client_secret=config["client_secret"],
-        config_file=config_filepath,
-        auth_cache_path=auth_filepath,
     )
     spotibar_client.auth()
 
     try:
-        with open(config_filepath, "w") as fh:
+        os.makedirs(os.path.expanduser("~/.config/spotibar/"), exist_ok=True)
+        os.makedirs(os.path.expanduser("~/.cache/spotibar/"), exist_ok=True)
+        with open(os.path.expanduser("~/.config/spotibar/default.json"), "x") as fh:
             json.dump(config, fh)
 
     except Exception as e:
@@ -413,12 +393,6 @@ def main():
         description="Entrypoint for Spotify/Polybar integration."
     )
 
-    parser.add_argument("--config-filepath", default="~/.spotibar_config.json")
-    parser.add_argument(
-        "--auth-filepath",
-        default="~/.spotibar_cache/auth_cache"
-    )
-
     group = parser.add_mutually_exclusive_group()
     group.add_argument("--get-currently-playing", action="store_true")
     group.add_argument("--previous-track", action="store_true")
@@ -437,16 +411,10 @@ def main():
 
         sys.exit(0)
 
-    spotibar_client = (
-        SpotibarClient(
-            config_file=args.config_filepath,
-            require_clients=False,
-            auth_cache_path=args.auth_filepath,
-        ) if args.is_live else SpotibarClient(
-            config_file=args.config_filepath,
-            auth_cache_path=args.auth_filepath,
-        )
-    )
+    if args.is_live:
+        spotibar_client = SpotibarClient(require_clients=False)
+    else:
+        spotibar_client = SpotibarClient()
 
     if args.get_currently_playing:
         print(spotibar_client.get_currently_playing_string())

src/spotibar/config_helper.py

@@ -4,49 +4,44 @@
 
 class SpotibarConfig:
     def __init__(self, *args, **kwargs):
-        self.config_file = kwargs.get("config_file", ".spotibar_config.json")
-
-        self.path = os.path.expanduser("~") + "/" + self.config_file
-
-        # If we supply an absolute path, use that instead of expanding the home
-        # dir.
-        if self.config_file[0] == "/":
-            self.path = self.config_file
+        self.config_file = os.path.expanduser(
+            kwargs.get("config_file", "~/.config/spotibar/default.json")
+        )
 
     def get(self, key, default):
-        if not os.path.exists(self.path):
+        if not os.path.exists(self.config_file):
             return default
         try:
-            with open(self.path, "r") as fh:
+            with open(self.config_file, "r") as fh:
                 config = json.load(fh)
 
                 if key in config.keys():
                     return config[key]
                 else:
                     return default
         except Exception as e:
-            print(f"Problem reading from ~/{self.config_file}!")
+            print(f"Problem reading from {self.config_file}!")
             print(e)
 
     def set(self, key, value):
         config = None
 
         try:
-            with open(self.path, "r") as fh:
+            with open(self.config_file, "r") as fh:
                 config = json.load(fh)
         except Exception as e:
-            print(f"Problem reading from ~/{self.config_file}!")
+            print(f"Problem reading from {self.config_file}!")
             print(e)
 
             return
 
         config[key] = value
 
         try:
-            with open(self.path, "w") as fh:
+            with open(self.config_file, "w") as fh:
                 json.dump(config, fh)
         except Exception as e:
-            print(f"Problem writing to ~/{self.config_file}!")
+            print(f"Problem writing to {self.config_file}!")
             print(e)
 
             return