dunst: add dunst, a do-not-disturb button for muting notifications

Author: jcinis

dunst/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Jessey White-Cinis
+
+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.

dunst/README.md

@@ -0,0 +1,33 @@
+# dunst
+
+Creates a do-not-disturb button for muting [dunst](https://dunst-project.org/) notifications.
+
+![](dunst.gif)
+
+
+# Dependencies
+
+- [dunst](https://dunst-project.org/)
+- [Font Awesome](https://fontawesome.com) for the [bell](https://fontawesome.com/icons/bell?style=solid) and [bell-slash](https://fontawesome.com/icons/bell-slash?style=solid) icons
+
+
+# Usage
+
+Clicking the bell icon will toggle dunst notifications from being displayed.
+
+This is accomplished by sending ```notify-send``` the special ```DUNST_COMMAND_PAUSE``` or ```DUNST_COMMAND_RESUME``` message.
+
+
+# Config
+
+```INI
+[dunst]
+command=$SCRIPT_DIR/dunst
+interval=once
+format=json
+markup=pango
+#min_width=50
+#align=center
+#DUNST_MUTE=off
+```
+

dunst/dunst

@@ -0,0 +1,59 @@
+#!/usr/bin/env python3
+"""
+A do-not-disturb button for muting Dunst notifications in i3 using i3blocks
+
+Mute is handled by passing 'DUNST_COMMAND_PAUSE' and 'DUNST_COMMAND_RESUME' to
+the notify-send script and the 'DUNST_MUTE' environment variable is set to keep
+track of the toggle.
+"""
+
+__author__ = "Jessey White-Cinis <[email protected]>"
+__copyright__ = "Copyright (c) 2019 Jessey White-Cinis"
+__license__ = "MIT"
+__version__ = "1.0.0"
+
+import os
+import subprocess
+import json
+
+def mute_on():
+    '''Turns off dunst notifications'''
+    subprocess.run(["notify-send","DUNST_COMMAND_PAUSE"])
+    return {
+        "full_text":"<span font='Font Awesome 5 Free Solid' color='#BE616E'>\uf1f6</span>",
+        "DUNST_MUTE":"on"
+    }
+
+def mute_off():
+    '''Turns back on dunst notifications'''
+    subprocess.run(["notify-send","DUNST_COMMAND_RESUME"])
+    return {
+        "full_text":"<span font='Font Awesome 5 Free Solid' color='#A4B98E'>\uf0f3</span>",
+        "DUNST_MUTE":"off"
+    }
+
+def clicked():
+    '''Returns True if the button was clicked'''
+    button = "BLOCK_BUTTON" in os.environ and os.environ["BLOCK_BUTTON"]
+    return bool(button)
+
+def muted():
+    '''Returns True if Dunst is muted'''
+    mute = "DUNST_MUTE" in os.environ and os.environ["DUNST_MUTE"]
+    return mute == 'on'
+
+if clicked():
+    # toggle button click to turn mute on and off
+    if muted():
+        RTN = mute_off()
+    else:
+        RTN = mute_on()
+
+else:
+    # Set default state using 'DUNST_MUTE' environment variable
+    if muted():
+        RTN = mute_on()
+    else:
+        RTN = mute_off()
+
+print(json.dumps(RTN))

dunst/dunst.gif

@@ -0,0 +1,9 @@
+[dunst]
+command=$SCRIPT_DIR/dunst
+markup=pango
+interval=once
+format=json
+#min_width=50
+#align=center
+#DUNST_MUTE=off
+