rbeesoft 1.0.2__py3-none-any.whl → 1.0.3__py3-none-any.whl

rbeesoft/app.py

@@ -1,23 +1,23 @@
-import sys
-
-from PySide6 import QtWidgets
-
-import rbeesoft.ui.constants as constants
-
-from rbeesoft.ui.settings import Settings
-from rbeesoft.ui.mainwindow import MainWindow
-
-
-def main():
-    settings = Settings()
-    application_name = settings.get(constants.RBEESOFT_WINDOW_TITLE)
-    QtWidgets.QApplication.setApplicationName(application_name)
-    app = QtWidgets.QApplication(sys.argv)
-    app.setApplicationName(application_name)
-    main_window = MainWindow()
-    main_window.show()
-    sys.exit(app.exec())
-
-
-if __name__ == '__main__':
+import sys
+
+from PySide6 import QtWidgets
+
+import rbeesoft.ui.constants as constants
+
+from rbeesoft.ui.settings import Settings
+from rbeesoft.ui.mainwindow import MainWindow
+
+
+def main():
+    settings = Settings()
+    application_name = settings.get(constants.RBEESOFT_WINDOW_TITLE)
+    QtWidgets.QApplication.setApplicationName(application_name)
+    app = QtWidgets.QApplication(sys.argv)
+    app.setApplicationName(application_name)
+    main_window = MainWindow()
+    main_window.show()
+    sys.exit(app.exec())
+
+
+if __name__ == '__main__':
     main()

rbeesoft/core/singleton.py

@@ -1,9 +1,9 @@
-def singleton(cls):
-    _instances = {}
-
-    def instance(*args, **kwargs):
-        if cls not in _instances:
-            _instances[cls] = cls(*args, **kwargs)
-        return _instances[cls]
-    
+def singleton(cls):
+    _instances = {}
+
+    def instance(*args, **kwargs):
+        if cls not in _instances:
+            _instances[cls] = cls(*args, **kwargs)
+        return _instances[cls]
+    
     return instance

rbeesoft/core/utils/functions.py

@@ -1,10 +1,10 @@
-import pendulum
-
-
-def create_name_with_timestamp(prefix: str='') -> str:
-    tz = pendulum.local_timezone()
-    timestamp = pendulum.now(tz).strftime('%Y%m%d%H%M%S%f')[:17]
-    if prefix != '' and not prefix.endswith('-'):
-        prefix = prefix + '-'
-    name = f'{prefix}{timestamp}'
+import pendulum
+
+
+def create_name_with_timestamp(prefix: str='') -> str:
+    tz = pendulum.local_timezone()
+    timestamp = pendulum.now(tz).strftime('%Y%m%d%H%M%S%f')[:17]
+    if prefix != '' and not prefix.endswith('-'):
+        prefix = prefix + '-'
+    name = f'{prefix}{timestamp}'
     return name

rbeesoft/core/utils/logmanager.py

@@ -1,35 +1,35 @@
-import datetime
-
-from rbeesoft.core.singleton import singleton
-
-
-@singleton
-class LogManager:
-    def __init__(self, suppress_print=False):
-        self._suppress_print = suppress_print
-        self._listeners = []
-
-    def _log(self, level, message):
-        timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')
-        message = f'[{timestamp}] {level} : {message}'
-        if not self._suppress_print:
-            print(message)
-        self.notify_listeners(message)
-        return message
-
-    def info(self, message):
-        return self._log('INFO', message)
-
-    def warning(self, message):
-        return self._log('WARNING', message)
-
-    def error(self, message):
-        return self._log('ERROR', message)
-    
-    def add_listener(self, listener):
-        if listener not in self._listeners:
-            self._listeners.append(listener)
-
-    def notify_listeners(self, message):
-        for listener in self._listeners:
-            listener.new_message(message)
+import datetime
+
+from rbeesoft.core.singleton import singleton
+
+
+@singleton
+class LogManager:
+    def __init__(self, suppress_print=False):
+        self._suppress_print = suppress_print
+        self._listeners = []
+
+    def _log(self, level, message):
+        timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')
+        message = f'[{timestamp}] {level} : {message}'
+        if not self._suppress_print:
+            print(message)
+        self.notify_listeners(message)
+        return message
+
+    def info(self, message):
+        return self._log('INFO', message)
+
+    def warning(self, message):
+        return self._log('WARNING', message)
+
+    def error(self, message):
+        return self._log('ERROR', message)
+    
+    def add_listener(self, listener):
+        if listener not in self._listeners:
+            self._listeners.append(listener)
+
+    def notify_listeners(self, message):
+        for listener in self._listeners:
+            listener.new_message(message)

rbeesoft/core/utils/logmanagerlistener.py

@@ -1,3 +1,3 @@
-class LogManagerListener:
-    def new_message(self, message):
+class LogManagerListener:
+    def new_message(self, message):
         raise NotImplementedError()

rbeesoft/ui/components/splashscreen.py

@@ -0,0 +1,121 @@
+import os
+import webbrowser
+
+from PySide6.QtWidgets import (
+    QWidget,
+    QVBoxLayout,
+    QPushButton,
+    QLabel,
+)
+from PySide6.QtCore import Qt
+from PySide6.QtGui import QPixmap
+
+from rbeesoft.ui.constants import Constants
+
+from rbeesoft.ui.utils import resource_path, set_opacity
+
+
+class SplashScreen(QWidget):
+    def __init__(self, main_window, title, background_image_file_path=None):
+        super(SplashScreen, self).__init__()
+        self._main_window = main_window
+        self._title = title
+        self._background_image_file_path = background_image_file_path
+        self._background_label = None
+        self._background_pixmap = None
+        self._title_label = None
+        self._sub_text_label = None
+        self._start_app_button = None
+        self._donate_button = None
+        self._close_button = None
+        self.init_layout()
+
+    def main_window(self):
+        return self._main_window
+    
+    def title(self):
+        return self._title
+    
+    def background_image_file_path(self):
+        return self._background_image_file_path
+    
+    def background_label(self):
+        if not self._background_label and self._background_image_file_path:
+            self._background_label = QLabel(self)
+            self._background_label.setPixmap(self.background_pixmap())
+            self._background_label.setGeometry(0, 0, self.width(), self.height())
+            self._background_label.lower()
+        return self._background_label
+    
+    def background_pixmap(self):
+        if not self._background_pixmap and self._background_image_file_path:
+            self._background_pixmap = QPixmap(resource_path(os.path.join(
+                Constants.RBEESOFT_RESOURCES_IMAGES_DIR, 
+                Constants.RBEESOFT_SPLASH_SCREEN_BACKGROUND_IMAGE,
+            ))).scaled(self.size(), Qt.IgnoreAspectRatio, Qt.SmoothTransformation)
+            self._background_pixmap = set_opacity(self._background_pixmap, Constants.RBEESOFT_SPLASH_SCREEN_BACKGROUND_IMAGE_OPACITY)
+        return self._background_pixmap
+    
+    def title_label(self):
+        if not self._title_label:
+            self._title_label = QLabel(Constants.RBEESOFT_SPLASH_SCREEN_TITLE)
+            self._title_label.setStyleSheet(Constants.RBEESOFT_SPLASH_SCREEN_TITLE_STYLE_SHEET)
+            self._title_label.setAlignment(Qt.AlignCenter)
+        return self._title_label
+    
+    def sub_text_label(self):
+        if not self._sub_text_label:
+            self._sub_text_label = QLabel(Constants.RBEESOFT_SPLASH_SCREEN_SUB_TEXT)
+            self._sub_text_label.setStyleSheet(Constants.RBEESOFT_SPLASH_SCREEN_SUB_TEXT_STYLE_SHEET)
+            self._sub_text_label.setAlignment(Qt.AlignCenter)
+        return self._sub_text_label
+    
+    def start_app_button(self):
+        if not self._start_app_button:
+            self._start_app_button = QPushButton(Constants.RBEESOFT_SPLASH_SCREEN_START_APP_BUTTON_TEXT)
+            self._start_app_button.clicked.connect(self.handle_start_app_button)
+        return self._start_app_button
+    
+    def donate_button(self):
+        if not self._donate_button:
+            self._donate_button = QPushButton(Constants.RBEESOFT_DONATE_BUTTON_TEXT)
+            self._donate_button.setStyleSheet(Constants.RBEESOFT_DONATE_BUTTON_STYLESHEET)
+            self._donate_button.clicked.connect(self.handle_donate_button)
+        return self._donate_button
+    
+    def close_button(self):
+        if not self._close_button:
+            self._close_button = QPushButton(Constants.RBEESOFT_SPLASH_SCREEN_CLOSE_BUTTON_TEXT)
+            self._close_button.clicked.connect(self.handle_close_button)
+        return self._close_button
+    
+    # LAYOUT
+
+    def init_layout(self):
+        layout = QVBoxLayout()
+        layout.addWidget(self.title_label())
+        layout.addWidget(self.sub_text_label())
+        layout.addWidget(self.start_app_button())
+        # layout.addWidget(self.donate_button())
+        layout.addWidget(self.close_button())
+        self.setLayout(layout)
+        self.setFixedSize(Constants.RBEESOFT_SPLASH_SCREEN_WINDOW_W, Constants.RBEESOFT_SPLASH_SCREEN_WINDOW_H)
+        self.setWindowFlags(Qt.FramelessWindowHint)
+    
+    # EVENT HANDLERS
+
+    def handle_start_app_button(self):
+        self.close()
+        self.main_window().show()
+
+    def handle_donate_button(self):
+        webbrowser.open(Constants.RBEESOFT_DONATE_URL)
+
+    def handle_close_button(self):
+        self.close()
+
+    def resizeEvent(self, event):
+        super().resizeEvent(event)
+        scaled = self.background_pixmap().scaled(self.size(), Qt.KeepAspectRatioByExpanding, Qt.SmoothTransformation)
+        self.background_label().setPixmap(scaled)
+        self.background_label().setGeometry(0, 0, self.width(), self.height())

rbeesoft/ui/constants.py

@@ -1,44 +1,45 @@
-from PySide6.QtWidgets import QStyle
-
-from rbeesoft.ui.utils import is_macos
-
-
-# MAIN APPLICATION
-RBEESOFT_WINDOW_TITLE = 'Rbeesoft'
-RBEESOFT_NAME = 'rbeesoft'
-RBEESOFT_BUNDLE_IDENTIFIER = 'com.rbeesoft'
-RBEESOFT_WINDOW_W = 1024
-RBEESOFT_WINDOW_H = 600
-RBEESOFT_WINDOW_GEOMETRY_KEY = 'window/geometry'
-RBEESOFT_WINDOW_STATE_KEY = 'window/state'
-RBEESOFT_STATUS_READY = 'Ready'
-RBEESOFT_DONATE_URL = 'https://rbeesoft.nl/wordpress/'
-RBEESOFT_DONATE_BUTTON_TEXT = 'If you wish to support us, please consider a donation by clicking here!'
-RBEESOFT_DONATE_BUTTON_STYLESHEET = 'background-color: blue; color: white; font-weight: bold;'
-RBEESOFT_LAST_DIRECTORY_KEY = 'last_directory'
-# https://www.pythonguis.com/faq/built-in-qicons-pyqt/#qt-standard-icons
-RBEESOFT_ICON_EXIT = QStyle.SP_MessageBoxCritical
-RBEESOFT_ICON_SETTINGS = QStyle.SP_VistaShield
-
-# RESOURCES
-RBEESOFT_RESOURCES_DIR = 'rbeesoft/resources'
-RBEESOFT_RESOURCES_IMAGES_DIR = 'rbeesoft/resources/images'
-RBEESOFT_RESOURCES_IMAGES_ICONS_DIR = 'rbeesoft/resources/images/icons'
-RBEESOFT_RESOURCES_ICON = 'rbeesoft.icns' if is_macos() else 'rbeesoft.ico'
-
-# MENUS
-RBEESOFT_APP_MENU_TEXT = 'Application'
-RBEESOFT_APP_MENU_OPEN_SETTINGS_PANEL_ACTION_TEXT = 'Settings...'
-RBEESOFT_APP_MENU_EXIT_ACTION_TEXT = 'Exit'
-
-# PANELS
-RBEESOFT_MAIN_PANEL_NAME = 'mainpanel'
-RBEESOFT_MAIN_PANEL_NAME_TITLE_LABEL_STYLESHEET = 'color: black; font-weight: bold; font-size: 14pt;'
-RBEESOFT_LOG_PANEL_TITLE = 'Output log'
-RBEESOFT_LOG_PANEL_NAME = 'logpanel'
-RBEESOFT_LOG_PANEL_CLEAR_LOGS_BUTTON = 'Clear logs'
-RBEESOFT_SETTINGS_PANEL_TITLE = 'Settings'
-RBEESOFT_SETTINGS_PANEL_NAME ='settingspanel'
-RBEESOFT_SETTINGS_PANEL_NAME_COLUMN_NAME = 'NAME'
-RBEESOFT_SETTINGS_PANEL_VALUE_COLUMN_NAME = 'VALUE'
-RBEESOFT_SETTINGS_PANEL_CANNOT_DISPLAY_MESSAGE = 'Cannot display (binary data)'
+from PySide6.QtWidgets import QStyle
+
+from rbeesoft.ui.utils import is_macos
+
+
+class Constants:
+    # MAIN APPLICATION
+    RBEESOFT_WINDOW_TITLE = 'Rbeesoft'
+    RBEESOFT_NAME = 'rbeesoft'
+    RBEESOFT_BUNDLE_IDENTIFIER = 'com.rbeesoft'
+    RBEESOFT_WINDOW_W = 1024
+    RBEESOFT_WINDOW_H = 600
+    RBEESOFT_WINDOW_GEOMETRY_KEY = 'window/geometry'
+    RBEESOFT_WINDOW_STATE_KEY = 'window/state'
+    RBEESOFT_STATUS_READY = 'Ready'
+    RBEESOFT_DONATE_URL = 'https://rbeesoft.nl/wordpress/'
+    RBEESOFT_DONATE_BUTTON_TEXT = 'If you wish to support us, please consider a donation by clicking here!'
+    RBEESOFT_DONATE_BUTTON_STYLESHEET = 'background-color: blue; color: white; font-weight: bold;'
+    RBEESOFT_LAST_DIRECTORY_KEY = 'last_directory'
+    # https://www.pythonguis.com/faq/built-in-qicons-pyqt/#qt-standard-icons
+    RBEESOFT_ICON_EXIT = QStyle.SP_MessageBoxCritical
+    RBEESOFT_ICON_SETTINGS = QStyle.SP_VistaShield
+
+    # RESOURCES
+    RBEESOFT_RESOURCES_DIR = 'rbeesoft/resources'
+    RBEESOFT_RESOURCES_IMAGES_DIR = 'rbeesoft/resources/images'
+    RBEESOFT_RESOURCES_IMAGES_ICONS_DIR = 'rbeesoft/resources/images/icons'
+    RBEESOFT_RESOURCES_ICON = 'rbeesoft.icns' if is_macos() else 'rbeesoft.ico'
+
+    # MENUS
+    RBEESOFT_APP_MENU_TEXT = 'Application'
+    RBEESOFT_APP_MENU_OPEN_SETTINGS_PANEL_ACTION_TEXT = 'Settings...'
+    RBEESOFT_APP_MENU_EXIT_ACTION_TEXT = 'Exit'
+
+    # PANELS
+    RBEESOFT_MAIN_PANEL_NAME = 'mainpanel'
+    RBEESOFT_MAIN_PANEL_NAME_TITLE_LABEL_STYLESHEET = 'color: black; font-weight: bold; font-size: 14pt;'
+    RBEESOFT_LOG_PANEL_TITLE = 'Output log'
+    RBEESOFT_LOG_PANEL_NAME = 'logpanel'
+    RBEESOFT_LOG_PANEL_CLEAR_LOGS_BUTTON = 'Clear logs'
+    RBEESOFT_SETTINGS_PANEL_TITLE = 'Settings'
+    RBEESOFT_SETTINGS_PANEL_NAME ='settingspanel'
+    RBEESOFT_SETTINGS_PANEL_NAME_COLUMN_NAME = 'NAME'
+    RBEESOFT_SETTINGS_PANEL_VALUE_COLUMN_NAME = 'VALUE'
+    RBEESOFT_SETTINGS_PANEL_CANNOT_DISPLAY_MESSAGE = 'Cannot display (binary data)'

rbeesoft/ui/mainwindow.py

@@ -1,127 +1,66 @@
-import os
-
-from PySide6.QtWidgets import (
-    QMainWindow,
-)
-from PySide6.QtGui import (
-    QGuiApplication,
-    QAction,
-    QIcon,
-)
-from PySide6.QtCore import Qt, QByteArray
-
-import rbeesoft.ui.constants as constants
-
-from rbeesoft.ui.settings import Settings
-from rbeesoft.ui.panels.mainpanel import MainPanel
-from rbeesoft.ui.panels.logpanel import LogPanel
-from rbeesoft.ui.panels.settingspanel import SettingsPanel
-from rbeesoft.ui.utils import resource_path, version, is_macos
-from rbeesoft.core.utils.logmanager import LogManager
-
-LOG = LogManager()
-
-
-class MainWindow(QMainWindow):
-    def __init__(self):
-        super(MainWindow, self).__init__()
-        self._settings = None
-        self._main_panel = None
-        self._settings_panel = None
-        self._log_panel = None
-        self.init_window()
-
-    def init_window(self):
-        self.setWindowTitle(f'{constants.RBEESOFT_WINDOW_TITLE} {version(constants.RBEESOFT_NAME)}')
-        self.setWindowIcon(QIcon(resource_path(os.path.join(
-            constants.RBEESOFT_RESOURCES_IMAGES_ICONS_DIR, constants.RBEESOFT_RESOURCES_ICON))))
-        if not self.load_geometry_and_state():
-            self.set_default_size_and_position()
-        self.init_menus()
-        self.init_status_bar()
-        self.addDockWidget(Qt.DockWidgetArea.TopDockWidgetArea, self.main_panel())
-        self.addDockWidget(Qt.DockWidgetArea.BottomDockWidgetArea, self.log_panel())
-
-    def init_menus(self):
-        self.init_app_menu()
-        if is_macos():            
-            self.menuBar().setNativeMenuBar(False)
-
-    def init_app_menu(self):
-        open_settings_action = QAction(constants.RBEESOFT_APP_MENU_OPEN_SETTINGS_PANEL_ACTION_TEXT, self)
-        open_settings_action.triggered.connect(self.handle_open_settings_panel_action)
-        exit_action = QAction(constants.RBEESOFT_APP_MENU_EXIT_ACTION_TEXT, self)
-        exit_action.triggered.connect(self.close)
-        app_menu = self.menuBar().addMenu(constants.RBEESOFT_APP_MENU_TEXT)
-        app_menu.addAction(open_settings_action)
-        app_menu.addAction(exit_action)
-
-    def init_status_bar(self):
-        self.set_status(constants.RBEESOFT_STATUS_READY)
-
-    # GETTERS
-
-    def settings(self):
-        if not self._settings:
-            self._settings = Settings()
-        return self._settings
-    
-    def main_panel(self):
-        if not self._main_panel:
-            self._main_panel = MainPanel(self)
-            self._main_panel.add_panel(
-                self.settings_panel(), constants.RBEESOFT_SETTINGS_PANEL_NAME)
-            self._main_panel.select_panel(constants.RBEESOFT_SETTINGS_PANEL_NAME)
-        return self._main_panel
-    
-    def settings_panel(self):
-        if not self._settings_panel:
-            self._settings_panel = SettingsPanel()
-        return self._settings_panel
-    
-    def log_panel(self):
-        if not self._log_panel:
-            self._log_panel = LogPanel()
-            LOG.add_listener(self._log_panel)
-        return self._log_panel
-    
-    # SETTERS
-
-    def set_status(self, message):
-        self.statusBar().showMessage(message)
-
-    # EVENT HANDLERS
-
-    def handle_open_settings_panel_action(self):
-        self.main_panel().select_panel(constants.RBEESOFT_SETTINGS_PANEL_NAME)
-
-    def closeEvent(self, event):
-        self.save_geometry_and_state()
-        return super().closeEvent(event)
-    
-    # MISCELLANEOUS
-
-    def load_geometry_and_state(self):
-        geometry = self.settings().get(constants.RBEESOFT_WINDOW_GEOMETRY_KEY)
-        state = self.settings().get(constants.RBEESOFT_WINDOW_STATE_KEY)
-        if isinstance(geometry, QByteArray) and self.restoreGeometry(geometry):
-            if isinstance(state, QByteArray):
-                self.restoreState(state)
-            return True
-        return False
-
-    def save_geometry_and_state(self):
-        self.settings().set(
-            constants.RBEESOFT_WINDOW_GEOMETRY_KEY, self.saveGeometry())
-        self.settings().set(
-            constants.RBEESOFT_WINDOW_STATE_KEY, self.saveState())
-
-    def set_default_size_and_position(self):
-        self.resize(constants.RBEESOFT_WINDOW_W, constants.RBEESOFT_WINDOW_H)
-        self.center_window()
-
-    def center_window(self):
-        screen = QGuiApplication.primaryScreen().geometry()
-        x = (screen.width() - self.geometry().width()) / 2
-        y = (screen.height() - self.geometry().height()) / 2
+import os
+
+from PySide6.QtWidgets import (
+    QMainWindow,
+)
+from PySide6.QtGui import (
+    QGuiApplication,
+    QIcon,
+)
+from PySide6.QtCore import Qt, QByteArray
+
+from rbeesoft.ui.constants import Constants
+from rbeesoft.ui.settings import Settings
+from rbeesoft.ui.utils import resource_path, version
+
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super(MainWindow, self).__init__()
+        self._settings = None
+        self.init_window()
+
+    def init_window(self):
+        self.setWindowTitle(f'{Constants.RBEESOFT_WINDOW_TITLE} {version(Constants.RBEESOFT_NAME)}')
+        self.setWindowIcon(QIcon(resource_path(os.path.join(
+            Constants.RBEESOFT_RESOURCES_IMAGES_ICONS_DIR, Constants.RBEESOFT_RESOURCES_ICON))))
+        if not self.load_geometry_and_state():
+            self.set_default_size_and_position()
+
+    # GETTERS
+
+    def settings(self):
+        if not self._settings:
+            self._settings = Settings()
+        return self._settings
+    
+    def closeEvent(self, event):
+        self.save_geometry_and_state()
+        return super().closeEvent(event)
+    
+    # MISCELLANEOUS
+
+    def load_geometry_and_state(self):
+        geometry = self.settings().get(Constants.RBEESOFT_WINDOW_GEOMETRY_KEY)
+        state = self.settings().get(Constants.RBEESOFT_WINDOW_STATE_KEY)
+        if isinstance(geometry, QByteArray) and self.restoreGeometry(geometry):
+            if isinstance(state, QByteArray):
+                self.restoreState(state)
+            return True
+        return False
+
+    def save_geometry_and_state(self):
+        self.settings().set(
+            Constants.RBEESOFT_WINDOW_GEOMETRY_KEY, self.saveGeometry())
+        self.settings().set(
+            Constants.RBEESOFT_WINDOW_STATE_KEY, self.saveState())
+
+    def set_default_size_and_position(self):
+        self.resize(Constants.RBEESOFT_WINDOW_W, Constants.RBEESOFT_WINDOW_H)
+        self.center_window()
+
+    def center_window(self):
+        screen = QGuiApplication.primaryScreen().geometry()
+        x = (screen.width() - self.geometry().width()) / 2
+        y = (screen.height() - self.geometry().height()) / 2
         self.move(int(x), int(y))

rbeesoft/ui/panels/defaultpanel.py

@@ -1,13 +1,13 @@
-from PySide6.QtWidgets import QWidget
-
-
-class DefaultPanel(QWidget):
-    def __init__(self):
-        super(DefaultPanel, self).__init__()
-        self._title = None
-
-    def title(self):
-        return self._title
-    
-    def set_title(self, title):
+from PySide6.QtWidgets import QWidget
+
+
+class DefaultPanel(QWidget):
+    def __init__(self):
+        super(DefaultPanel, self).__init__()
+        self._title = None
+
+    def title(self):
+        return self._title
+    
+    def set_title(self, title):
         self._title = title