rbeesoft 1.0.1__py3-none-any.whl

rbeesoft/app.py

@@ -0,0 +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__':
+    main()

rbeesoft/core/singleton.py

@@ -0,0 +1,9 @@
+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

@@ -0,0 +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}'
+    return name

rbeesoft/core/utils/logmanager.py

@@ -0,0 +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)

rbeesoft/core/utils/logmanagerlistener.py

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

rbeesoft/resources/VERSION

@@ -0,0 +1 @@
+1.0.0

rbeesoft/ui/constants.py

@@ -0,0 +1,44 @@
+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)'

rbeesoft/ui/mainwindow.py

@@ -0,0 +1,127 @@
+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
+        self.move(int(x), int(y))

rbeesoft/ui/panels/defaultpanel.py

@@ -0,0 +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):
+        self._title = title

rbeesoft/ui/panels/logpanel.py

@@ -0,0 +1,53 @@
+from PySide6.QtWidgets import (
+    QWidget,
+    QDockWidget,
+    QTextEdit,
+    QPushButton,
+    QVBoxLayout,
+    QLabel,
+)
+
+import rbeesoft.ui.constants as constants
+
+from rbeesoft.core.utils.logmanagerlistener import LogManagerListener
+
+
+class LogPanel(QDockWidget, LogManagerListener):
+    def __init__(self):
+        super(LogPanel, self).__init__()
+        self._title_label = None
+        self._text_edit = None
+        self.init_layout()
+
+    def title_label(self):
+        if not self._title_label:
+            self._title_label = QLabel(constants.RBEESOFT_LOG_PANEL_TITLE)
+        return self._title_label
+
+    def text_edit(self):
+        if not self._text_edit:
+            self._text_edit = QTextEdit()
+        return self._text_edit
+    
+    def init_layout(self):
+        clear_logs_button = QPushButton(constants.RBEESOFT_LOG_PANEL_CLEAR_LOGS_BUTTON)
+        clear_logs_button.clicked.connect(self.handle_clear_logs_button)
+        layout = QVBoxLayout()
+        # layout.addWidget(self.title_label())
+        layout.addWidget(self.text_edit())
+        layout.addWidget(clear_logs_button)
+        container = QWidget()
+        container.setLayout(layout)
+        self.setObjectName(constants.RBEESOFT_LOG_PANEL_NAME)
+        self.setWindowTitle(self.title_label().text())
+        self.setWidget(container)
+
+    def add_line(self, line):
+        self.text_edit().insertPlainText(line + '\n')
+
+    def handle_clear_logs_button(self):
+        self.text_edit().clear()
+
+    # implements(LogManagerListener)
+    def new_message(self, message):
+        self.add_line(message)

rbeesoft/ui/panels/mainpanel.py

@@ -0,0 +1,81 @@
+import webbrowser
+
+from PySide6.QtWidgets import (
+    QWidget,
+    QLabel,
+    QPushButton,
+    QVBoxLayout,
+    QDockWidget,
+)
+
+import rbeesoft.ui.constants as constants
+
+from rbeesoft.ui.settings import Settings
+from rbeesoft.ui.panels.stackedpanel import StackedPanel
+from rbeesoft.core.utils.logmanager import LogManager
+
+LOG = LogManager()
+
+
+class MainPanel(QDockWidget):
+    def __init__(self, parent):
+        super(MainPanel, self).__init__(parent)
+        self._settings = None
+        self._title_label = None
+        self._donate_button = None
+        self._stacked_panel = None
+        self._panels = {}
+        self.init_layout()
+
+    def init_layout(self):
+        layout = QVBoxLayout()
+        layout.addWidget(self.title_label())
+        # layout.addWidget(self.donate_button())
+        layout.addWidget(self.stacked_panel())
+        container = QWidget()
+        container.setLayout(layout)
+        self.setObjectName(constants.RBEESOFT_MAIN_PANEL_NAME)
+        self.setWidget(container)
+
+    # GETTERS
+
+    def settings(self):
+        if not self._settings:
+            self._settings = Settings()
+        return self._settings
+    
+    def title_label(self):
+        if not self._title_label:
+            self._title_label = QLabel('')
+            self._title_label.setStyleSheet(constants.RBEESOFT_MAIN_PANEL_NAME_TITLE_LABEL_STYLESHEET)
+        return self._title_label
+    
+    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 stacked_panel(self):
+        if not self._stacked_panel:
+            self._stacked_panel = StackedPanel()
+        return self._stacked_panel
+    
+    def panels(self):
+        return self._panels
+
+    # ADDING PANELS
+
+    def add_panel(self, panel, name):
+        self.panels()[name] = panel.title()
+        self.stacked_panel().add_panel(panel, name)
+
+    def select_panel(self, name):
+        self.title_label().setText(self.panels().get(name))
+        self.stacked_panel().switch_to(name)
+
+    # EVENT HANDLERS
+
+    def handle_donate_button(self):
+        webbrowser.open(constants.RBEESOFT_DONATE_URL)

rbeesoft/ui/panels/settingspanel.py

@@ -0,0 +1,62 @@
+from PySide6.QtWidgets import (
+    QTableWidget,
+    QTableWidgetItem,
+    QHeaderView,
+    QVBoxLayout,
+    QSizePolicy,
+)
+from PySide6.QtCore import Qt
+
+import rbeesoft.ui.constants as constants
+
+from rbeesoft.ui.settings import Settings
+from rbeesoft.ui.panels.defaultpanel import DefaultPanel
+
+
+class SettingsPanel(DefaultPanel):
+    def __init__(self):
+        super(SettingsPanel, self).__init__()
+        self.set_title(constants.RBEESOFT_SETTINGS_PANEL_TITLE)
+        self._title_label = None
+        self._settings = None
+        self._settings_table_widget = None
+        self.init_layout()
+
+    def settings(self):
+        if not self._settings:
+            self._settings = Settings()
+        return self._settings
+    
+    def settings_table_widget(self):
+        if not self._settings_table_widget:
+            self._settings_table_widget = QTableWidget()
+            self._settings_table_widget.setSortingEnabled(True)
+            self._settings_table_widget.horizontalHeader().setVisible(True)
+            self._settings_table_widget.verticalHeader().setVisible(False)
+            self._settings_table_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+            self._settings_table_widget.setRowCount(len(self.settings().allKeys()))
+            self._settings_table_widget.setColumnCount(2)
+            self._settings_table_widget.setAlternatingRowColors(True)
+            row_index = 0
+            for key in self.settings().allKeys():
+                self._settings_table_widget.setItem(row_index, 0, QTableWidgetItem(key))
+                value = self.settings().get(key)
+                if isinstance(value, str) or isinstance(value, int) or isinstance(value, bool) or isinstance(value, float):
+                    self._settings_table_widget.setItem(row_index, 1, QTableWidgetItem(str(value)))
+                else:
+                    self._settings_table_widget.setItem(row_index, 1, QTableWidgetItem(constants.RBEESOFT_SETTINGS_PANEL_CANNOT_DISPLAY_MESSAGE))
+                row_index += 1
+            self._settings_table_widget.resizeColumnsToContents()
+            self._settings_table_widget.sortItems(0, Qt.AscendingOrder)
+            self._settings_table_widget.setHorizontalHeaderLabels([
+                constants.RBEESOFT_SETTINGS_PANEL_NAME_COLUMN_NAME, constants.RBEESOFT_SETTINGS_PANEL_VALUE_COLUMN_NAME])
+            self._settings_table_widget.horizontalHeader().setSectionResizeMode(QHeaderView.Interactive)
+            self._settings_table_widget.horizontalHeader().setSectionResizeMode(1, QHeaderView.Stretch)
+            self._settings_table_widget.horizontalHeader().setDefaultAlignment(Qt.AlignLeft | Qt.AlignVCenter)
+        return self._settings_table_widget
+
+    def init_layout(self):
+        layout = QVBoxLayout()
+        layout.addWidget(self.settings_table_widget())
+        self.setLayout(layout)
+        self.setObjectName(constants.RBEESOFT_SETTINGS_PANEL_NAME)

rbeesoft/ui/panels/stackedpanel.py

@@ -0,0 +1,22 @@
+from PySide6.QtWidgets import QStackedWidget
+
+
+class StackedPanel(QStackedWidget):
+    def __init__(self):
+        super(StackedPanel, self).__init__()
+        self._current_panel_name = None
+        self._panels = {}
+
+    def add_panel(self, panel, name):
+        if name not in self._panels.keys():
+            self._panels[name] = panel
+            self._current_panel_name = name
+            self.addWidget(panel)
+
+    def current_panel_name(self):
+        return self._current_panel_name
+
+    def switch_to(self, name):
+        panel = self._panels[name]
+        self._current_panel_name = name
+        self.setCurrentWidget(panel)

rbeesoft/ui/settings.py

@@ -0,0 +1,32 @@
+from PySide6.QtCore import QSettings
+
+import rbeesoft.ui.constants as constants
+
+
+class Settings(QSettings):
+    def __init__(self):
+        super(Settings, self).__init__(
+            QSettings.IniFormat, 
+            QSettings.UserScope, 
+            constants.RBEESOFT_BUNDLE_IDENTIFIER, 
+            constants.RBEESOFT_NAME,
+        )
+
+    def prepend_bundle_identifier_and_name(self, name):
+        return '{}.{}.{}'.format(
+            constants.RBEESOFT_BUNDLE_IDENTIFIER, 
+            constants.RBEESOFT_NAME,
+            name,
+        )
+
+    def get(self, name, default=None):
+        if not name.startswith(constants.RBEESOFT_BUNDLE_IDENTIFIER):
+            name = self.prepend_bundle_identifier_and_name(name)
+        value = self.value(name)
+        if value is None or value == '':
+            return default
+        return value
+    
+    def set(self, name, value):
+        name = self.prepend_bundle_identifier_and_name(name)
+        self.setValue(name, value)

rbeesoft/ui/utils.py

@@ -0,0 +1,32 @@
+import os
+import sys
+
+from PySide6.QtGui import QPixmap, QPainter, QColor
+
+
+def resource_path(relative_path):
+    base_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
+    return os.path.join(base_path, relative_path)
+
+
+def version(app_name):
+    with open(resource_path(f'{app_name}/resources/VERSION'), 'r') as f:
+        return f.readline().strip()
+
+
+def is_macos():
+    return sys.platform.startswith('darwin')
+
+
+def icon(parent, icon_type):
+    return parent.style().standardIcon(icon_type)
+
+
+def set_opacity(pixmap, opacity):
+    result = QPixmap(pixmap.size())
+    result.fill(QColor(0, 0, 0, 0))
+    painter = QPainter(result)
+    painter.setOpacity(opacity)
+    painter.drawPixmap(0, 0, pixmap)
+    painter.end()
+    return result