ci(workflow): add GitHub Actions workflow for building and releasing application

This commit introduces a new GitHub Actions workflow defined in `main.yml`, which automates the process of building the application using PyInstaller. The workflow includes steps for checking out the repository, setting up Python, installing dependencies, building the executable, compressing the output, generating a changelog, and creating a release on GitHub.

Additionally, it adds a version file to manage application versioning and modifies the tray icon behavior to check for the existence of the built executable before deciding how to create a startup shortcut. This enhances the deployment process and ensures that the application can be easily built and released with minimal manual intervention.

Author: amnweb

.github/workflows/main.yml

@@ -0,0 +1,67 @@
+name: Build with PyInstaller
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.12'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pyinstaller
+        pip install -r requirements.txt
+        
+    - name: Build with PyInstaller
+      run: |
+        pyinstaller --noconfirm --onedir --console --icon "src/assets/favicon/app_icon.ico" --name "yasb" --contents-directory "libs" --clean --optimize "1" --version-file "src/version.txt" --bootloader-ignore-signals --hidden-import "core.widgets.yasb.power_menu" --hidden-import "core.widgets.yasb.volume" --hidden-import "core.widgets.yasb.weather" --hidden-import "core.widgets.yasb.memory" --hidden-import "core.widgets.yasb.cpu" --hidden-import "core.widgets.yasb.active_window" --hidden-import "core.widgets.yasb.applications" --hidden-import "core.widgets.yasb.battery" --hidden-import "core.widgets.yasb.clock" --hidden-import "core.widgets.yasb.custom" --hidden-import "core.widgets.yasb.github" --hidden-import "core.widgets.yasb.media" --hidden-import "core.widgets.yasb.wallpapers" --hidden-import "core.widgets.yasb.traffic" --hidden-import "core.widgets.komorebi.active_layout" --hidden-import "core.widgets.komorebi.workspaces" --hidden-import "core.widgets.yasb.wifi" --add-data "src/assets;assets/"  "src/main.py"
+    - name: Compress artifact
+      run: |
+        Compress-Archive -Path dist/yasb -DestinationPath dist/yasb_win.zip
+
+    - name: Get app version
+      id: get_version
+      run: |
+        $version = (Select-String -Path "src/version.txt" -Pattern 'filevers=\(([0-9, ]+)\)' | ForEach-Object { $_.Matches.Groups[1].Value.Trim() -replace ' ', '' -replace ',', '.' })
+        echo "VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+    - name: Create changelog text
+      id: changelog
+      uses: loopwerk/tag-changelog@v1
+      with:
+        token: ${{ secrets.PAT }}
+
+    - name: Create Release
+      id: create_release
+      uses: ncipollo/release-action@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.PAT }}
+      with:
+        artifacts: dist/yasb_win.zip
+        tag: v${{ env.VERSION }}
+        name: Release ${{ env.VERSION }}
+        body: |
+          Changelog for version ${{ env.VERSION }}
+          ${{ steps.changelog.outputs.changes }}
+        draft: true
+        prerelease: false
+
+    - name: Upload Release Asset
+      uses: xresloader/upload-to-github-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.PAT }}
+      with:
+        file: "dist/yasb_win.zip"
+        release_id: ${{ steps.create_release.outputs.id }}
+        update_release_body: ${{ github.ref }}
+        update_release_body_append: "true"
+        draft: true
+        overwrite: true
+        prerelease: false

src/assets/favicon/app_icon.ico

@@ -13,9 +13,21 @@
 from settings import GITHUB_URL, SCRIPT_PATH, APP_NAME, DEFAULT_CONFIG_DIRECTORY
 
 OS_STARTUP_FOLDER = os.path.join(os.environ['APPDATA'], r'Microsoft\Windows\Start Menu\Programs\Startup')
-AUTOSTART_FILE = os.path.join(SCRIPT_PATH, 'yasb.vbs')
-SHORTCUT_FILENAME = "yasb.lnk"
-
+yasb_vbs_path = os.path.join(SCRIPT_PATH, 'yasb.vbs')
+
+# Check if exe file exists, if exists
+yasb_exe_path = os.path.join(os.path.dirname(SCRIPT_PATH), 'yasb.exe')
+if os.path.exists(yasb_exe_path):
+    print("yasb.exe exists in the directory.")
+    SHORTCUT_FILENAME = "yasb.lnk"
+    AUTOSTART_FILE = yasb_exe_path
+    WORKING_DIRECTORY = os.path.dirname(SCRIPT_PATH)
+else:
+    print("yasb.exe does not exist in the directory.")
+    SHORTCUT_FILENAME = "yasb.lnk"
+    AUTOSTART_FILE = yasb_vbs_path
+    WORKING_DIRECTORY = SCRIPT_PATH
+    
 class TrayIcon(QSystemTrayIcon):
 
     def __init__(self, bar_manager: BarManager):
@@ -107,7 +119,7 @@ def _enable_startup(self):
         try:
             with winshell.shortcut(shortcut_path) as shortcut:
                 shortcut.path = AUTOSTART_FILE
-                shortcut.working_directory = SCRIPT_PATH
+                shortcut.working_directory = WORKING_DIRECTORY
                 shortcut.description = "Shortcut to yasb.vbs"
             logging.info(f"Created shortcut at {shortcut_path}")
         except Exception as e:

src/core/tray.py

@@ -1,25 +1,43 @@
 import re
+import ctypes
+import logging
 from core.widgets.base import BaseWidget
 from core.validation.widgets.yasb.volume import VALIDATION_SCHEMA
 from PyQt6.QtWidgets import QLabel, QHBoxLayout, QWidget
-from PyQt6.QtCore import Qt
+from PyQt6.QtCore import Qt, pyqtSignal
 from PyQt6.QtGui import QWheelEvent
-from comtypes import CLSCTX_ALL, CoInitialize, CoUninitialize
-from pycaw.pycaw import AudioUtilities, IAudioEndpointVolume
-import ctypes
-import logging
-
+from comtypes import CLSCTX_ALL, CoInitialize, CoUninitialize, COMObject
+from pycaw.pycaw import AudioUtilities, IAudioEndpointVolume, IAudioEndpointVolumeCallback
+from pycaw.callbacks import MMNotificationClient
+ 
 # Disable comtypes logging
 logging.getLogger('comtypes').setLevel(logging.CRITICAL)
 
 # Constants from the Windows API
 VK_VOLUME_UP = 0xAF
 VK_VOLUME_DOWN = 0xAE
 KEYEVENTF_KEYUP = 0x0002
-UPDATE_INTERVAL = 1000
-
+ 
+class AudioEndpointChangeCallback(MMNotificationClient):
+    def __init__(self,parent):
+        super().__init__()
+        self.parent = parent
+ 
+    def on_property_value_changed(self, device_id, property_struct, fmtid, pid):        
+        self.parent.update_label_signal.emit()
+        
+class AudioEndpointVolumeCallback(COMObject):
+    _com_interfaces_ = [IAudioEndpointVolumeCallback]
+    def __init__(self, parent):
+        super().__init__()
+        self.parent = parent
+    def OnNotify(self, pNotify):
+        self.parent.update_label_signal.emit()
+ 
+          
 class VolumeWidget(BaseWidget):
     validation_schema = VALIDATION_SCHEMA
+    update_label_signal = pyqtSignal()
 
     def __init__(
         self,
@@ -28,7 +46,7 @@ def __init__(
         volume_icons: list[str],
         callbacks: dict[str, str]
     ):
-        super().__init__(UPDATE_INTERVAL, class_name="volume-widget")
+        super().__init__(class_name="volume-widget")
         self._show_alt_label = False
         self._label_content = label
         self._label_alt_content = label_alt
@@ -49,10 +67,17 @@ def __init__(
         self.callback_left = "toggle_mute"
         self.callback_right = callbacks["on_right"]
         self.callback_middle = callbacks["on_middle"]
-        self.callback_timer = "update_label"
-
-        self.start_timer()
+        
+        self.cb = AudioEndpointChangeCallback(self)
+        self.enumerator = AudioUtilities.GetDeviceEnumerator()
+        self.enumerator.RegisterEndpointNotificationCallback(self.cb)
+        
+        self._initialize_volume_interface()
+        self.update_label_signal.connect(self._update_label)
+        
+        self._update_label()
 
+        
     def _toggle_label(self):
         self._show_alt_label = not self._show_alt_label
         for widget in self._widgets:
@@ -96,7 +121,6 @@ def _update_label(self):
         label_parts = re.split('(<span.*?>.*?</span>)', active_label_content)
         label_parts = [part for part in label_parts if part]
         widget_index = 0
-
         try:
             self._initialize_volume_interface()
             mute_status = self.volume.GetMute()
@@ -130,13 +154,13 @@ def _get_volume_icon(self):
         self.setToolTip(f'Volume {current_volume_level}')
         if current_mute_status == 1:
             volume_icon = self._volume_icons[0]
-        elif (current_volume_level >= 0 and current_volume_level < 11):
+        elif 0 <= current_volume_level < 11:
             volume_icon = self._volume_icons[1]
-        elif (current_volume_level >= 11 and current_volume_level < 30):
+        elif 11 <= current_volume_level < 30:
             volume_icon = self._volume_icons[2]
-        elif (current_volume_level >= 30 and current_volume_level < 60):
+        elif 30 <= current_volume_level < 60:
             volume_icon = self._volume_icons[3]
-        elif (current_volume_level >= 60):
+        else:
             volume_icon = self._volume_icons[4]
         return volume_icon
 
@@ -158,16 +182,20 @@ def wheelEvent(self, event: QWheelEvent):
         elif event.angleDelta().y() < 0:
             self._decrease_volume()
 
+
     def toggle_mute(self):
         current_mute_status = self.volume.GetMute()
         self.volume.SetMute(not current_mute_status, None)
         self._update_label()
-
+   
+   
     def _initialize_volume_interface(self):
         CoInitialize()
         try:
             devices = AudioUtilities.GetSpeakers()
             interface = devices.Activate(IAudioEndpointVolume._iid_, CLSCTX_ALL, None)
             self.volume = interface.QueryInterface(IAudioEndpointVolume)
+            self.callback = AudioEndpointVolumeCallback(self)
+            self.volume.RegisterControlChangeNotify(self.callback)
         finally:
-            CoUninitialize()
+            CoUninitialize()         

src/core/widgets/yasb/volume.py

@@ -0,0 +1,37 @@
+# UTF-8
+#
+# More details about fixed file info 'ffi':
+# http://msdn.microsoft.com/en-us/library/ms646997.aspx
+#
+VSVersionInfo(
+    ffi=FixedFileInfo(
+        filevers=(1, 0, 0, 0),
+        prodvers=(1, 0, 0, 0),
+        mask=0x3f,
+        flags=0x0,
+        OS=0x4,
+        fileType=0x1,
+        subtype=0x0,
+        date=(0, 0)
+    ),
+    kids=[
+        StringFileInfo(
+            [
+                StringTable(
+                    '040904B0',
+                    [
+                        StringStruct('CompanyName', 'amnweb'),
+                        StringStruct('FileDescription', 'Yet Another Status Bar'),
+                        StringStruct('FileVersion', '1.0.0.0'),
+                        StringStruct('InternalName', 'yasb'),
+                        StringStruct('LegalCopyright', '© AmN. All rights reserved.'),
+                        StringStruct('OriginalFilename', 'yasb.exe'),
+                        StringStruct('ProductName', 'yasb'),
+                        StringStruct('ProductVersion', '1.0.0.0')
+                    ]
+                )
+            ]
+        ),
+        VarFileInfo([VarStruct('Translation', [1033, 1200])])
+    ]
+)