chore: match project structure to best pratices implement in other repositories

Author: dy0gu

.github/dependabot.yml

@@ -5,7 +5,13 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

.github/workflows/convention.yaml

@@ -12,7 +12,7 @@ concurrency:
 
 jobs:
   title:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       pull-requests: read
     steps:

.github/workflows/deploy.yaml

@@ -14,7 +14,7 @@ defaults:
 
 jobs:
   prepare:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     outputs:
       nuitka: ${{ steps.extract.outputs.nuitka }}
       version: ${{ steps.extract.outputs.version }}
@@ -45,7 +45,7 @@ jobs:
 
   macos:
     needs: [prepare]
-    runs-on: macos-latest
+    runs-on: macos-15
 
     steps:
       - uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 # v4.2.2
@@ -91,7 +91,7 @@ jobs:
 
   linux:
     needs: [prepare]
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
       - uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 # v4.2.2
@@ -136,7 +136,7 @@ jobs:
 
   windows:
     needs: [prepare]
-    runs-on: windows-latest
+    runs-on: windows-2025
 
     steps:
       - uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 # v4.2.2

.github/workflows/lint.yaml

@@ -11,7 +11,7 @@ concurrency:
 
 jobs:
   check:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@85e6279cec87321a52edac9c87bce653a07cf6c2 # v4.2.2
       - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0

.github/workflows/release.yaml

@@ -18,7 +18,7 @@ permissions:
 
 jobs:
   metadata:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     outputs:
       desktop: ${{ steps.metadata.outputs.release_created }}
     steps:

.github/workflows/test.yaml

@@ -13,7 +13,7 @@ jobs:
   e2e:
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-24.04, windows-2025, macos-15]
       fail-fast: false
     env:
       DISPLAY: ":99.0"
@@ -25,7 +25,7 @@ jobs:
           python-version-file: "pyproject.toml"
           cache: "pip"
       - uses: tlambert03/setup-qt-libs@19e4ef2d781d81f5f067182e228b54ec90d23b76 # v1.8.0
-      - if: ${{ matrix.os == 'ubuntu-latest' }}
+      - if: ${{ matrix.os == 'ubuntu-24.04' }}
         run: sudo apt-get install pulseaudio -y
       - name: Install dependencies
         run: pip install .[test]

src/pages/guide.py

@@ -23,8 +23,8 @@ def __init__(self):
 
 <p>
     Running the app will display the first input in the logs box and the second after 3 seconds, if it was entered.
-    An example error will also be shown halfway through the process. If the app is minimized when the process ends a
-    notification will be sent and the app will blink/jump in the taskbar depending on the operating system.
+    An example error will also be shown halfway through the process. If the app is minimized when the process ends it
+    will blink/jump in the taskbar depending on the operating system.
 </p>
 
 <p>
@@ -45,8 +45,8 @@ def __init__(self):
     <h3>Certification</h3>
 
     <ul>
-        <li>Sign the app during the build process using a trusted certificate authority.</li>
-        <li>These are usually paid services but having the app signed will remove the insecuriy warning from some operating systems.</li>
+        <li>Sign the app after the build process using a trusted certificate authority.</li>
+        <li>These are usually paid services but having the app signed will remove the insecurity warning from some operating systems.</li>
     </ul>
 
     <h3>Localization</h3>

src/pages/home.py

@@ -17,6 +17,7 @@
 from services.example import ExampleThread
 from utils.data_saver import config
 from utils import file_loader
+from utils.logger import LogLevel
 
 
 class HomePage(QWidget):
@@ -148,23 +149,22 @@ def runExample(self):
             self.secondInputField.text(),
         )
 
-        def output(text, level):
-            if level == "ERROR":
+        def output(text: str, level: LogLevel):
+            if level == LogLevel.ERROR.value:
                 self.runLogsBox.append(f'<font color="red">{text}</font>')
-            else:
+            elif level == LogLevel.WARNING.value:
+                self.runLogsBox.append(f'<font color="olive">{text}</font>')
+            elif level == LogLevel.SUCCESS.value:
                 self.runLogsBox.append(f'<font color="green">{text}</font>')
+            else:
+                self.runLogsBox.append(f'<font color="gray">{text}</font>')
             self.runLogsClearButton.setDisabled(False)
 
         self.worker.outputSignal.connect(output)
 
         def finished():
             self.runButton.setDisabled(False)
             App.alert(self, 0)
-            # if (
-            #     App.applicationState()
-            #     == Qt.ApplicationState.ApplicationInactive
-            # ):
-            #     SystemTray().send("Example finished!", "Go back to the app.")
             self.finishSound.play()
 
         self.worker.finished.connect(finished)

src/services/example.py

@@ -1,6 +1,6 @@
 from PySide6.QtCore import QThread, Signal
 
-from utils.logger import logger
+from utils.logger import LogLevel, logger
 
 
 class ExampleThread(QThread):
@@ -13,15 +13,17 @@ def __init__(self, firstInput: str, secondInput: str | None = None):
         self.firstInput = firstInput
         self.secondInput = secondInput
 
-    def output(self, text: str, level="INFO"):
-        logger.log(level, text)
-        self.outputSignal.emit(text, level)
+    def output(self, text: str, level: LogLevel = LogLevel.INFO):
+        logger.log(level.value, text)
+        self.outputSignal.emit(text, level.value)
 
     def run(self):
-        inputs = self.__dict__.copy()
-        logger.info(f"Starting example thread with input parameters: {inputs}")
-        self.output("...")
-        with logger.catch():
+        try:
+            inputs = self.__dict__.copy()
+            logger.info(
+                f"Starting example thread with input parameters: {inputs}"
+            )
+            self.output("...")
             self.output("Your first input was: " + self.firstInput)
             self.output(
                 "If you entered text in the second input it will be shown here after 3 seconds"
@@ -30,7 +32,12 @@ def run(self):
             try:
                 raise Exception("This is an example error after 1.5 seconds")
             except Exception as e:
-                self.output(str(e), "ERROR")
+                self.output(str(e), LogLevel.ERROR)
             self.msleep(1500)
             if self.secondInput:
                 self.output("Your second input was: " + self.secondInput)
+        except Exception as error:
+            self.output(
+                f"An unexpected error occurred: {f'{error}'.split(';')[0][9:]}",
+                LogLevel.ERROR,
+            )

src/utils/logger.py

@@ -1,4 +1,5 @@
 import datetime
+from enum import Enum
 import os
 import sys
 
@@ -9,18 +10,33 @@
 
 LOGS_PATH = os.path.join(DATA_PATH, "logs")
 
+
+class LogLevel(Enum):
+    TRACE = "TRACE"
+    DEBUG = "DEBUG"
+    INFO = "INFO"
+    SUCCESS = "SUCCESS"
+    WARNING = "WARNING"
+    ERROR = "ERROR"
+    CRITICAL = "CRITICAL"
+
+
 formatter = (
     "[{time:YYYY-MM-DDTHH:mm:ss.SSS[Z]!UTC}] [<level>{level}</level>] {message}"
 )
 
 dev = "__compiled__" not in globals()
 
 logger.remove()
-logger.level("INFO", color="<green>")
+logger.level(LogLevel.INFO.value, color="<green>")
 
 if dev:
     logger.add(
-        sys.stdout, colorize=True, format=formatter, level="DEBUG", enqueue=True
+        sys.stdout,
+        colorize=True,
+        format=formatter,
+        level=LogLevel.DEBUG.value,
+        enqueue=True,
     )
 
 logger.add(
@@ -29,7 +45,7 @@
     rotation=datetime.time(0, 0, 0, tzinfo=datetime.timezone.utc),
     retention="30 days",
     enqueue=True,
-    level="DEBUG" if dev else "INFO",
+    level=LogLevel.DEBUG.value if dev else LogLevel.INFO.value,
 )