fix: import pyqtRemoveInputHook only for pyqt distributions

.gitlab-ci.yml

@@ -22,13 +22,6 @@ workflow:
 
 include:
   - template: Security/Secret-Detection.gitlab-ci.yml
-  - project: "bec/awi_utils"
-    file: "/templates/check-packages-job.yml"
-    inputs:
-      stage: test
-      path: "."
-      pytest_args: "-v --random-order tests/"
-      exclude_packages: ""
 
 # different stages in the pipeline
 stages:
@@ -39,21 +32,21 @@ stages:
   - Deploy
 
 .install-qt-webengine-deps: &install-qt-webengine-deps
-  - apt-get -y install libnss3 libxdamage1 libasound2 libatomic1 libxcursor1
-  - export QTWEBENGINE_DISABLE_SANDBOX=1
+    - apt-get -y install libnss3 libxdamage1 libasound2 libatomic1 libxcursor1
+    - export QTWEBENGINE_DISABLE_SANDBOX=1
 
 .clone-repos: &clone-repos
-  - git clone --branch $BEC_CORE_BRANCH https://gitlab.psi.ch/bec/bec.git
-  - git clone --branch $OPHYD_DEVICES_BRANCH https://gitlab.psi.ch/bec/ophyd_devices.git
-  - export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
-
+    - git clone --branch $BEC_CORE_BRANCH https://gitlab.psi.ch/bec/bec.git
+    - git clone --branch $OPHYD_DEVICES_BRANCH https://gitlab.psi.ch/bec/ophyd_devices.git
+    - export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
+  
 .install-os-packages: &install-os-packages
-  - apt-get update
-  - apt-get install -y libgl1-mesa-glx libegl1-mesa x11-utils libxkbcommon-x11-0 libdbus-1-3
-  - *install-qt-webengine-deps
+    - apt-get update
+    - apt-get install -y libgl1-mesa-glx libegl1-mesa x11-utils libxkbcommon-x11-0 libdbus-1-3
+    - *install-qt-webengine-deps
 
 before_script:
-  - if [[ "$CI_PROJECT_PATH" != "bec/bec_widgets" ]]; then
+  - if [[ "$CI_PROJECT_PATH" != "bec/bec_widgets" ]]; then 
     echo -e "\033[35;1m Using branch $CHILD_PIPELINE_BRANCH of BEC Widgets \033[0;m";
     test -d bec_widgets || git clone --branch $CHILD_PIPELINE_BRANCH https://gitlab.psi.ch/bec/bec_widgets.git; cd bec_widgets;
     fi
@@ -99,10 +92,10 @@ pylint-check:
     - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
     # Identify changed Python files
     - if [ "$CI_PIPELINE_SOURCE" == "merge_request_event" ]; then
-      TARGET_BRANCH_COMMIT_SHA=$(git rev-parse origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME);
-      CHANGED_FILES=$(git diff --name-only $TARGET_BRANCH_COMMIT_SHA HEAD | grep '\.py$' || true);
+        TARGET_BRANCH_COMMIT_SHA=$(git rev-parse origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME);
+        CHANGED_FILES=$(git diff --name-only $TARGET_BRANCH_COMMIT_SHA HEAD | grep '\.py$' || true);
       else
-      CHANGED_FILES=$(git diff --name-only $CI_COMMIT_BEFORE_SHA $CI_COMMIT_SHA | grep '\.py$' || true);
+        CHANGED_FILES=$(git diff --name-only $CI_COMMIT_BEFORE_SHA $CI_COMMIT_SHA | grep '\.py$' || true);
       fi
     - if [ -z "$CHANGED_FILES" ]; then echo "No Python files changed."; exit 0; fi
 
@@ -127,7 +120,7 @@ tests:
   stage: test
   needs: []
   variables:
-    QT_QPA_PLATFORM: "offscreen"
+      QT_QPA_PLATFORM: "offscreen"
   script:
     - *clone-repos
     - *install-os-packages
@@ -148,21 +141,21 @@ tests:
 test-matrix:
   parallel:
     matrix:
-      - PYTHON_VERSION:
-          - "3.10"
-          - "3.11"
-          - "3.12"
-        QT_PCKG:
-          - "pyside6"
-          - "pyqt5"
-          - "pyqt6"
+      - PYTHON_VERSION: 
+        - "3.10"
+        - "3.11"
+        - "3.12"
+        QT_PCKG: 
+        - "pyside6"
+        - "pyqt5"
+        - "pyqt6"
 
   stage: AdditionalTests
   needs: []
   variables:
-    QT_QPA_PLATFORM: "offscreen"
-    PYTHON_VERSION: ""
-    QT_PCKG: ""
+      QT_QPA_PLATFORM: "offscreen"
+      PYTHON_VERSION: ""
+      QT_PCKG: ""
   image: $CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX/python:$PYTHON_VERSION
   script:
     - *clone-repos
@@ -233,7 +226,7 @@ semver:
     - pip install python-semantic-release==9.* wheel build twine
     - export GL_TOKEN=$CI_UPDATES
     - semantic-release -vv version
-
+    
     # check if any artifacts were created
     - if [ ! -d dist ]; then echo No release will be made; exit 0; fi
     - twine upload dist/* -u __token__ -p $CI_PYPI_TOKEN --skip-existing
@@ -249,7 +242,7 @@ pages:
   variables:
     TARGET_BRANCH: $CI_COMMIT_REF_NAME
   rules:
-    - if: "$CI_COMMIT_TAG != null"
+    - if: '$CI_COMMIT_TAG != null'
       variables:
         TARGET_BRANCH: $CI_COMMIT_TAG
     - if: '$CI_COMMIT_REF_NAME == "main" && $CI_PROJECT_PATH == "bec/bec_widgets"'

CHANGELOG.md

@@ -1,95 +1,6 @@
 # CHANGELOG
 
-## v0.64.2 (2024-06-19)
 
-### Fix
-
-* fix(client_utils): added close rpc command to shutdown of gui from bec_ipython_client ([`e5a7d47`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e5a7d47b21cbf066f740f1d11d7c9ea7c70f3080))
-
-## v0.64.1 (2024-06-19)
-
-### Fix
-
-* fix(widgets): removed widget module import of sub widgets ([`216511b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/216511b951ff0e15b6d7c70133095f3ac45c23f4))
-
-### Refactor
-
-* refactor(utils): moved get_rpc_widgets to plugin_utils ([`6dabbf8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6dabbf874fbbdde89c34a7885bf95aa9c895a28b))
-
-### Test
-
-* test: moved rpc_classes test ([`b3575eb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b3575eb06852b456cde915dfda281a3e778e3aeb))
-
-## v0.64.0 (2024-06-19)
-
-### Ci
-
-* ci: add job optional dependency check ([`27426ce`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/27426ce7a52b4cbad7f3bef114d6efe6ad73bd7f))
-
-### Documentation
-
-* docs: fix links in developer section ([`9e16f2f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9e16f2faf9c59a5d36ae878512c5a910cca31e69))
-
-* docs: refactor developer section, add widget tutorial ([`2a36d93`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2a36d9364f242bf42e4cda4b50e6f46aa3833bbd))
-
-### Feature
-
-* feat: add option to change size of the fonts ([`ea805d1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ea805d1362fc084d3b703b6f81b0180072f0825d))
-
-### Fix
-
-* fix(plot_base): font size is set with setScale which is scaling the whole legend window ([`5d66720`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d6672069ea1cbceb62104f66c127e4e3c23e4a4))
-
-### Test
-
-* test: add tests ([`140ad83`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/140ad83380808928edf7953e23c762ab72a0a1e9))
-
-## v0.63.2 (2024-06-14)
-
-### Fix
-
-* fix: do not import "server" in client, prevents from having trouble with QApplication creation order
-
-Like with QtWebEngine ([`6f96498`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6f96498de66358b89f3a2035627eed2e02dde5a1))
-
-### Unknown
-
-* Reapply "feat: implement non-polling, interruptible waiting of gui instruction response with timeout"
-
-This reverts commit fe04dd80e59a0e74f7fdea603e0642707ecc7c2a. ([`836b6e6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/836b6e64f694916d6b6f909dedf11a4a6d2c86a4))
-
-## v0.63.1 (2024-06-13)
-
-### Fix
-
-* fix: just terminate the remote process in close() instead of communicating
-
-The proper finalization sequence will be executed by the remote process
-on SIGTERM ([`9263f8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9263f8ef5c17ae7a007a1a564baf787b39061756))
-
-## v0.63.0 (2024-06-13)
-
-### Documentation
-
-* docs: add documentation ([`bc709c4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bc709c4184c985d4e721f9ea7d1b3dad5e9153a7))
-
-### Feature
-
-* feat: add textbox widget ([`d9d4e3c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d9d4e3c9bf73ab2a5629c2867b50fc91e69489ec))
-
-### Refactor
-
-* refactor: add pydantic config, add change_theme ([`6b8432f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6b8432f5b20a71175a3537b5f6832b76e3b67d73))
-
-### Test
-
-* test: add test for text box ([`b49462a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b49462abeb186e56bac79d2ef0b0add1ef28a1a5))
-
-### Unknown
-
-* Revert "feat: implement non-polling, interruptible waiting of gui instruction response with timeout"
-
-This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fe04dd80e59a0e74f7fdea603e0642707ecc7c2a))
 
 ## v0.62.0 (2024-06-12)
 
@@ -101,6 +12,7 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 * doc: add documentation about creating custom GUI applications embedding BEC Widgets ([`17a0068`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/17a00687579f5efab1990cd83862ec0e78198633))
 
+
 ## v0.61.0 (2024-06-12)
 
 ### Feature
@@ -111,6 +23,7 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 * refactor: improve labe of auto_update script ([`40b5688`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/40b568815893cd41af3531bb2e647ca1e2e315f4))
 
+
 ## v0.60.0 (2024-06-08)
 
 ### Ci
@@ -153,16 +66,100 @@ This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https:
 
 * test: added missing pylint statement to header ([`f662985`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f6629852ebc2b4ee239fa560cc310a5ae2627cf7))
 
+
 ## v0.59.1 (2024-06-07)
 
 ### Fix
 
 * fix(curve): set_color_map_z typo fixed in user access ([`e7838b0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e7838b0f2fc23b0a232ed7d68fbd7f3493a91b9e))
 
+
 ## v0.59.0 (2024-06-07)
 
+### Build
+
+* build: added webengine dependency ([`d56c549`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d56c5493cd28f379d04a79d90b01c73b0760da1b))
+
 ### Ci
 
 * ci: merged additional tests to parallel matrix job ([`178fe4d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/178fe4d2da3a959f7cd90e7ea0f47314dc1ef4ed))
 
 * ci: added webengine dependencies ([`2d79ef8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2d79ef8fe5e52c61f4a78782770377cd6b41958b))
+
+### Documentation
+
+* docs: added website docs ([`cf6e5a4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cf6e5a40fc8320e9898a446a5bf14b77e94ef013))
+
+### Feature
+
+* feat(widget): added simple website widget with rpc ([`64abd67`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/64abd67b9b416bff9c89880b248d6e8639aa1e70))
+
+
+## v0.58.1 (2024-06-07)
+
+### Fix
+
+* fix(dock): new dock can be detached upon creation ([`02a2608`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/02a26086c4540127a11c235cba30afc4fd712007))
+
+
+## v0.58.0 (2024-06-07)
+
+### Feature
+
+* feat(utils.colors): general color validators ([`3094632`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/30946321348abc349fb4003dc39d0232dc19606c))
+
+### Fix
+
+* fix: bar colormap dynamic setting ([`67fd5e8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/67fd5e8581f60fe64027ac57f1f12cefa4d28343))
+
+* fix: formatting isort ([`bf699ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bf699ec1fbe2aacd31854e84fb0438c336840fcf))
+
+* fix(curve): 2D scatter updated if color_map_z is changed ([`6985ff0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6985ff0fcef9791b53198206ec8cbccd1d65ef99))
+
+* fix(curve): color_map_z setting works ([`33f7be4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/33f7be42c512402dab3fdd9781a8234e3ec5f4ba))
+
+### Test
+
+* test(color): validation tests added ([`c0ddece`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c0ddeceeeabacbf33019a8f24b18821926dc17ac))
+
+
+## v0.57.7 (2024-06-07)
+
+### Documentation
+
+* docs: added schema of BECDockArea and BECFigure ([`828067f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/828067f486a905eb4678538df58e2bdd6c770de1))
+
+### Fix
+
+* fix: add model_config to pydantic models to allow runtime checks after creation ([`ca5e8d2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ca5e8d2fbbffbf221cc5472710fef81a33ee29d6))
+
+
+## v0.57.6 (2024-06-06)
+
+### Fix
+
+* fix(bar): docstrings extended ([`edb1775`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/edb1775967c3ff0723d0edad2b764f1ffc832b7c))
+
+
+## v0.57.5 (2024-06-06)
+
+### Documentation
+
+* docs(figure): docs adjusted to be compatible with new signature ([`c037b87`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c037b87675af91b26e8c7c60e76622d4ed4cf5d5))
+
+### Fix
+
+* fix(waveform): added .plot method with the same signature as BECFigure.plot ([`8479caf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8479caf53a7325788ca264e5bd9aee01f1d4c5a0))
+
+* fix(plot_base): .plot removed from plot_base.py, because there is no use case for it ([`82e2c89`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/82e2c898d2e26f786b2d481f85c647472675e75b))
+
+### Refactor
+
+* refactor(figure): logic for .add_image and .image consolidated; logic for .add_plot and .plot consolidated ([`52bc322`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/52bc322b2b8d3ef92ff3480e61bddaf32464f976))
+
+
+## v0.57.4 (2024-06-06)
+
+### Fix
+
+* fix(docks): set_title do update dock internal _name now ([`15cbc21`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/15cbc21e5bb3cf85f5822d44a2b3665b5aa2f346))

bec_widgets/cli/client.py

@@ -17,7 +17,6 @@ class Widgets(str, enum.Enum):
     BECDockArea = "BECDockArea"
     BECFigure = "BECFigure"
     SpiralProgressBar = "SpiralProgressBar"
-    TextBox = "TextBox"
     WebsiteWidget = "WebsiteWidget"
 
 
@@ -1044,37 +1043,33 @@ class BECImageShow(RPCBase):
             - y_scale: Literal["linear", "log"]
             - x_lim: tuple
             - y_lim: tuple
-            - legend_label_size: int
         """
 
     @rpc_call
-    def set_title(self, title: "str", size: "int" = None):
+    def set_title(self, title: "str"):
         """
         Set the title of the plot widget.
 
         Args:
             title(str): Title of the plot widget.
-            size(int): Font size of the title.
         """
 
     @rpc_call
-    def set_x_label(self, label: "str", size: "int" = None):
+    def set_x_label(self, label: "str"):
         """
         Set the label of the x-axis.
 
         Args:
             label(str): Label of the x-axis.
-            size(int): Font size of the label.
         """
 
     @rpc_call
-    def set_y_label(self, label: "str", size: "int" = None):
+    def set_y_label(self, label: "str"):
         """
         Set the label of the y-axis.
 
         Args:
             label(str): Label of the y-axis.
-            size(int): Font size of the label.
         """
 
     @rpc_call
@@ -1272,37 +1267,33 @@ class BECPlotBase(RPCBase):
             - y_scale: Literal["linear", "log"]
             - x_lim: tuple
             - y_lim: tuple
-            - legend_label_size: int
         """
 
     @rpc_call
-    def set_title(self, title: "str", size: "int" = None):
+    def set_title(self, title: "str"):
         """
         Set the title of the plot widget.
 
         Args:
             title(str): Title of the plot widget.
-            size(int): Font size of the title.
         """
 
     @rpc_call
-    def set_x_label(self, label: "str", size: "int" = None):
+    def set_x_label(self, label: "str"):
         """
         Set the label of the x-axis.
 
         Args:
             label(str): Label of the x-axis.
-            size(int): Font size of the label.
         """
 
     @rpc_call
-    def set_y_label(self, label: "str", size: "int" = None):
+    def set_y_label(self, label: "str"):
         """
         Set the label of the y-axis.
 
         Args:
             label(str): Label of the y-axis.
-            size(int): Font size of the label.
         """
 
     @rpc_call
@@ -1378,15 +1369,6 @@ class BECPlotBase(RPCBase):
         Remove the plot widget from the figure.
         """
 
-    @rpc_call
-    def set_legend_label_size(self, size: "int" = None):
-        """
-        Set the font size of the legend.
-
-        Args:
-            size(int): Font size of the legend.
-        """
-
 
 class BECWaveform(RPCBase):
     @property
@@ -1533,37 +1515,33 @@ class BECWaveform(RPCBase):
             - y_scale: Literal["linear", "log"]
             - x_lim: tuple
             - y_lim: tuple
-            - legend_label_size: int
         """
 
     @rpc_call
-    def set_title(self, title: "str", size: "int" = None):
+    def set_title(self, title: "str"):
         """
         Set the title of the plot widget.
 
         Args:
             title(str): Title of the plot widget.
-            size(int): Font size of the title.
         """
 
     @rpc_call
-    def set_x_label(self, label: "str", size: "int" = None):
+    def set_x_label(self, label: "str"):
         """
         Set the label of the x-axis.
 
         Args:
             label(str): Label of the x-axis.
-            size(int): Font size of the label.
         """
 
     @rpc_call
-    def set_y_label(self, label: "str", size: "int" = None):
+    def set_y_label(self, label: "str"):
         """
         Set the label of the y-axis.
 
         Args:
             label(str): Label of the y-axis.
-            size(int): Font size of the label.
         """
 
     @rpc_call
@@ -1639,15 +1617,6 @@ class BECWaveform(RPCBase):
         Remove the plot widget from the figure.
         """
 
-    @rpc_call
-    def set_legend_label_size(self, size: "int" = None):
-        """
-        Set the font size of the legend.
-
-        Args:
-            size(int): Font size of the legend.
-        """
-
 
 class Ring(RPCBase):
     @rpc_call
@@ -1928,48 +1897,6 @@ class SpiralProgressBar(RPCBase):
         """
 
 
-class StopButton(RPCBase):
-    @property
-    @rpc_call
-    def config_dict(self) -> "dict":
-        """
-        Get the configuration of the widget.
-
-        Returns:
-            dict: The configuration of the widget.
-        """
-
-    @rpc_call
-    def get_all_rpc(self) -> "dict":
-        """
-        Get all registered RPC objects.
-        """
-
-
-class TextBox(RPCBase):
-    @rpc_call
-    def set_color(self, background_color: str, font_color: str) -> None:
-        """
-        Set the background color of the Widget.
-
-        Args:
-            background_color (str): The color to set the background in HEX.
-            font_color (str): The color to set the font in HEX.
-        """
-
-    @rpc_call
-    def set_text(self, text: str) -> None:
-        """
-        Set the text of the Widget
-        """
-
-    @rpc_call
-    def set_font_size(self, size: int) -> None:
-        """
-        Set the font size of the text in the Widget.
-        """
-
-
 class WebsiteWidget(RPCBase):
     @rpc_call
     def set_url(self, url: str) -> None:

bec_widgets/cli/client_utils.py

@@ -86,8 +86,13 @@ def _start_plot_process(gui_id, gui_class, config) -> None:
     Start the plot in a new process.
     """
     # pylint: disable=subprocess-run-check
+    monitor_module = importlib.import_module("bec_widgets.cli.server")
+    monitor_path = monitor_module.__file__
+
     command = [
-        "bec-gui-server",
+        sys.executable,
+        "-u",
+        monitor_path,
         "--id",
         gui_id,
         "--config",
@@ -95,11 +100,7 @@ def _start_plot_process(gui_id, gui_class, config) -> None:
         "--gui_class",
         gui_class.__name__,
     ]
-    env_dict = os.environ.copy()
-    env_dict["PYTHONUNBUFFERED"] = "1"
-    process = subprocess.Popen(
-        command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env_dict
-    )
+    process = subprocess.Popen(command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     process_output_processing_thread = threading.Thread(target=_get_output, args=(process,))
     process_output_processing_thread.start()
     return process, process_output_processing_thread
@@ -173,20 +174,18 @@ class BECGuiClientMixin:
 
     def close(self) -> None:
         """
-        Close the gui window.
+        Close the figure.
         """
         if self._process is None:
             return
-
-        self._run_rpc("close", (), wait_for_rpc_response=False)
-        while self.gui_is_alive():
-            time.sleep(0.2)
-
+        if self.gui_is_alive():
+            self._run_rpc("close", (), wait_for_rpc_response=True)
+        else:
+            self._run_rpc("close", (), wait_for_rpc_response=False)
+        self._process.terminate()
+        self._process_output_processing_thread.join()
+        self._process = None
         self._client.shutdown()
-        if self._process:
-            self._process.terminate()
-            self._process_output_processing_thread.join()
-            self._process = None
 
     def print_log(self) -> None:
         """

bec_widgets/cli/generate_cli.py

@@ -2,6 +2,7 @@
 from __future__ import annotations
 
 import argparse
+import importlib
 import inspect
 import os
 import sys
@@ -9,8 +10,9 @@ from typing import Literal
 
 import black
 import isort
+from qtpy.QtWidgets import QGraphicsWidget, QWidget
 
-from bec_widgets.utils.plugin_utils import get_rpc_classes
+from bec_widgets.utils import BECConnector
 
 if sys.version_info >= (3, 11):
     from typing import get_overloads
@@ -136,6 +138,50 @@ class {class_name}(RPCBase):"""
         with open(file_name, "w", encoding="utf-8") as file:
             file.write(formatted_content)
 
+    @staticmethod
+    def get_rpc_classes(
+        repo_name: str,
+    ) -> dict[Literal["connector_classes", "top_level_classes"], list[type]]:
+        """
+        Get all RPC-enabled classes in the specified repository.
+
+        Args:
+            repo_name(str): The name of the repository.
+
+        Returns:
+            dict: A dictionary with keys "connector_classes" and "top_level_classes" and values as lists of classes.
+        """
+        connector_classes = []
+        top_level_classes = []
+        anchor_module = importlib.import_module(f"{repo_name}.widgets")
+        directory = os.path.dirname(anchor_module.__file__)
+        for root, _, files in sorted(os.walk(directory)):
+            for file in files:
+                if not file.endswith(".py") or file.startswith("__"):
+                    continue
+
+                path = os.path.join(root, file)
+                subs = os.path.dirname(os.path.relpath(path, directory)).split("/")
+                if len(subs) == 1 and not subs[0]:
+                    module_name = file.split(".")[0]
+                else:
+                    module_name = ".".join(subs + [file.split(".")[0]])
+
+                module = importlib.import_module(f"{repo_name}.widgets.{module_name}")
+
+                for name in dir(module):
+                    obj = getattr(module, name)
+                    if not hasattr(obj, "__module__") or obj.__module__ != module.__name__:
+                        continue
+                    if isinstance(obj, type) and issubclass(obj, BECConnector):
+                        connector_classes.append(obj)
+                        if len(subs) == 1 and (
+                            issubclass(obj, QWidget) or issubclass(obj, QGraphicsWidget)
+                        ):
+                            top_level_classes.append(obj)
+
+        return {"connector_classes": connector_classes, "top_level_classes": top_level_classes}
+
 
 def main():
     """
@@ -151,7 +197,7 @@ def main():
         current_path = os.path.dirname(__file__)
         client_path = os.path.join(current_path, "client.py")
 
-        rpc_classes = get_rpc_classes("bec_widgets")
+        rpc_classes = ClientGenerator.get_rpc_classes("bec_widgets")
         rpc_classes["connector_classes"].sort(key=lambda x: x.__name__)
 
         generator = ClientGenerator()

bec_widgets/cli/rpc_wigdet_handler.py

@@ -1,7 +1,6 @@
 from bec_widgets.utils import BECConnector
 from bec_widgets.widgets.figure import BECFigure
 from bec_widgets.widgets.spiral_progress_bar.spiral_progress_bar import SpiralProgressBar
-from bec_widgets.widgets.text_box.text_box import TextBox
 from bec_widgets.widgets.website.website import WebsiteWidget
 
 
@@ -12,7 +11,6 @@ class RPCWidgetHandler:
         "BECFigure": BECFigure,
         "SpiralProgressBar": SpiralProgressBar,
         "Website": WebsiteWidget,
-        "TextBox": TextBox,
     }
 
     @staticmethod

bec_widgets/cli/server.py

@@ -40,7 +40,7 @@ class BECWidgetsCLIServer:
         self._shutdown_event = False
         self._heartbeat_timer = QTimer()
         self._heartbeat_timer.timeout.connect(self.emit_heartbeat)
-        self._heartbeat_timer.start(200)
+        self._heartbeat_timer.start(200)  # Emit heartbeat every 1 seconds
 
     def on_rpc_update(self, msg: dict, metadata: dict):
         request_id = metadata.get("request_id")
@@ -105,7 +105,7 @@ class BECWidgetsCLIServer:
             self.client.connector.set(
                 MessageEndpoints.gui_heartbeat(self.gui_id),
                 messages.StatusMessage(name=self.gui_id, status=1, info={}),
-                expire=1,
+                expire=10,
             )
 
     def shutdown(self):  # TODO not sure if needed when cleanup is done at level of BECConnector
@@ -114,7 +114,7 @@ class BECWidgetsCLIServer:
         self.client.shutdown()
 
 
-def main():
+if __name__ == "__main__":  # pragma: no cover
     import argparse
     import os
     import sys
@@ -166,7 +166,3 @@ def main():
 
     app.aboutToQuit.connect(server.shutdown)
     sys.exit(app.exec())
-
-
-if __name__ == "__main__":  # pragma: no cover
-    main()

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -10,8 +10,8 @@ from qtpy.QtGui import QIcon
 from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
 
 from bec_widgets.utils import BECDispatcher, UILoader
+from bec_widgets.widgets import BECFigure
 from bec_widgets.widgets.dock.dock_area import BECDockArea
-from bec_widgets.widgets.figure import BECFigure
 from bec_widgets.widgets.jupyter_console.jupyter_console import BECJupyterConsole
 
 # class JupyterConsoleWidget(RichJupyterWidget):  # pragma: no cover:

bec_widgets/utils/plugin_utils.py

@@ -1,10 +1,6 @@
-import importlib
 import inspect
-import os
-from typing import Literal
 
 from bec_lib.plugin_helper import _get_available_plugins
-from qtpy.QtWidgets import QGraphicsWidget, QWidget
 
 from bec_widgets.utils import BECConnector
 
@@ -42,47 +38,3 @@ def get_plugin_widgets() -> dict[str, BECConnector]:
 
 def _filter_plugins(obj):
     return inspect.isclass(obj) and issubclass(obj, BECConnector)
-
-
-def get_rpc_classes(
-    repo_name: str,
-) -> dict[Literal["connector_classes", "top_level_classes"], list[type]]:
-    """
-    Get all RPC-enabled classes in the specified repository.
-
-    Args:
-        repo_name(str): The name of the repository.
-
-    Returns:
-        dict: A dictionary with keys "connector_classes" and "top_level_classes" and values as lists of classes.
-    """
-    connector_classes = []
-    top_level_classes = []
-    anchor_module = importlib.import_module(f"{repo_name}.widgets")
-    directory = os.path.dirname(anchor_module.__file__)
-    for root, _, files in sorted(os.walk(directory)):
-        for file in files:
-            if not file.endswith(".py") or file.startswith("__"):
-                continue
-
-            path = os.path.join(root, file)
-            subs = os.path.dirname(os.path.relpath(path, directory)).split("/")
-            if len(subs) == 1 and not subs[0]:
-                module_name = file.split(".")[0]
-            else:
-                module_name = ".".join(subs + [file.split(".")[0]])
-
-            module = importlib.import_module(f"{repo_name}.widgets.{module_name}")
-
-            for name in dir(module):
-                obj = getattr(module, name)
-                if not hasattr(obj, "__module__") or obj.__module__ != module.__name__:
-                    continue
-                if isinstance(obj, type) and issubclass(obj, BECConnector):
-                    connector_classes.append(obj)
-                    if len(subs) == 1 and (
-                        issubclass(obj, QWidget) or issubclass(obj, QGraphicsWidget)
-                    ):
-                        top_level_classes.append(obj)
-
-    return {"connector_classes": connector_classes, "top_level_classes": top_level_classes}

bec_widgets/widgets/__init__.py

@@ -1,5 +1,5 @@
-# from .buttons import StopButton
-# from .dock import BECDock, BECDockArea
-# from .figure import BECFigure, FigureConfig
-# from .scan_control import ScanControl
-# from .spiral_progress_bar import SpiralProgressBar
+from .buttons import StopButton
+from .dock import BECDock, BECDockArea
+from .figure import BECFigure, FigureConfig
+from .scan_control import ScanControl
+from .spiral_progress_bar import SpiralProgressBar

bec_widgets/widgets/console/console.py

@@ -0,0 +1,159 @@
+import logging
+import os
+import platform
+import sys
+
+import termqt
+from qtpy.QtCore import QSocketNotifier, Qt
+from qtpy.QtGui import QFont
+from qtpy.QtWidgets import QApplication, QHBoxLayout, QScrollBar, QWidget
+from termqt import Terminal
+
+try:
+    from qtpy.QtCore import pyqtRemoveInputHook
+
+    pyqtRemoveInputHook()
+except ImportError:
+    pass
+
+if platform.system() in ["Linux", "Darwin"]:
+    terminal_cmd = os.environ["SHELL"]
+
+    from termqt import TerminalPOSIXExecIO
+
+    class TerminalExecIO(TerminalPOSIXExecIO):
+        def _read_loop(self):
+            pass
+
+        def find_utf8_split(self, data):
+            """UTF-8 characters can be 1-4 bytes long, this finds first index which is not mid character
+
+            Character lengths include:
+              1 Bytes: 0xxxxxxx
+              2 Bytes: 110xxxxx 10xxxxxx
+              3 Bytes: 1110xxxx 10xxxxxx 10xxxxxx
+              4 bytes: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
+              Source: https://en.wikipedia.org/wiki/UTF-8#Encoding
+
+            Start at end of chunk moving backwards, find first UTF-8 start byte:
+              1 Bytes: 0xxxxxxx - 0x80 == 0x00
+              2 Bytes: 110xxxxx - 0xE0 == 0xC0
+              3 Bytes: 1110xxxx - 0xF0 == 0xE0
+              4 bytes: 11110xxx - 0xF8 == 0xF0
+
+            Parameters:
+              data (bytes) - buffer to be evaluated
+
+            Returns:
+              (int) - last position of complete UTF-8 character
+            """
+            pos = 0
+            for i, c in enumerate(reversed(data)):
+                if c & 0x80 == 0x00 or c & 0xE0 == 0xC0 or c & 0xF0 == 0xE0 or c & 0xF8 == 0xF0:
+                    pos = i
+                    break
+            return len(data) - pos
+
+        def _read(self, fd):
+            try:
+                data = os.read(fd, 2**16)  # read as much as possible
+            except OSError:
+                data = b""
+
+            if data:
+                self._read_buf += data
+                i = self.find_utf8_split(self._read_buf)
+                output = self._read_buf[:i]
+                self._read_buf = self._read_buf[i:]
+                self.stdout_callback(output)
+            else:
+                self.logger.info("Spawned process has been killed")
+                if self.running:
+                    self.running = False
+                    self.terminated_callback()
+                    os.close(fd)
+
+        def spawn(self):
+            super().spawn()
+            self._read_notifier = QSocketNotifier(self.fd, QSocketNotifier.Read)
+            self._read_notifier.activated.connect(self._read)
+
+        def write(self, buffer):
+            # same as original method, but without logging and without assert (unneeded)
+            if not self.running:
+                return
+            try:
+                os.write(self.fd, buffer)
+            except OSError:
+                self.running = False
+                self.terminated_callback()
+
+else:
+    terminal_cmd = "cmd.exe"
+    from termqt import TerminalWinptyIO as TerminalExecIO
+
+
+class TerminalWidget(QWidget):
+    def __init__(self, logger):
+        super().__init__()
+        self.logger = logger
+        self.terminal = Terminal(800, 600, logger=self.logger)
+        self.terminal.set_font()
+        self.terminal.maximum_line_history = 2000
+        self.scroll = QScrollBar(Qt.Vertical, self.terminal)
+        self.terminal.connect_scroll_bar(self.scroll)
+
+        layout = QHBoxLayout()
+        layout.addWidget(self.terminal)
+        layout.addWidget(self.scroll)
+        layout.setSpacing(0)
+        self.setLayout(layout)
+
+
+class BECConsole(QWidget):
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle(f"termqt on {platform.system()}")
+        self.logger = self.setup_logger()
+
+        self.terminal_widget = TerminalWidget(self.logger)
+
+        layout = QHBoxLayout()
+        layout.addWidget(self.terminal_widget)
+        self.setLayout(layout)
+
+        self.auto_wrap_enabled = True
+        self.platform = platform.system()
+
+        self.setup_terminal_io()
+
+    def setup_logger(self):
+        logger = logging.getLogger()
+        logger.setLevel(logging.DEBUG)
+        handler = logging.StreamHandler()
+        formatter = logging.Formatter("[%(asctime)s] > [%(filename)s:%(lineno)d] %(message)s")
+        handler.setFormatter(formatter)
+        logger.addHandler(handler)
+        return logger
+
+    def setup_terminal_io(self):
+        self.terminal_io = TerminalExecIO(
+            self.terminal_widget.terminal.row_len,
+            self.terminal_widget.terminal.col_len,
+            terminal_cmd,
+            logger=self.logger,
+        )
+        self.auto_wrap_enabled = False
+
+        self.terminal_widget.terminal.enable_auto_wrap(self.auto_wrap_enabled)
+        self.terminal_io.stdout_callback = self.terminal_widget.terminal.stdout
+        self.terminal_widget.terminal.stdin_callback = self.terminal_io.write
+        self.terminal_widget.terminal.resize_callback = self.terminal_io.resize
+        self.terminal_io.spawn()
+
+
+if __name__ == "__main__":
+    app = QApplication([])
+    main_window = BECConsole()
+    main_window.show()
+    sys.exit(app.exec())

bec_widgets/widgets/dock/dock.py

@@ -11,7 +11,7 @@ from bec_widgets.utils import BECConnector, ConnectionConfig, GridLayoutManager
 if TYPE_CHECKING:
     from qtpy.QtWidgets import QWidget
 
-    from bec_widgets.widgets.dock import BECDockArea
+    from bec_widgets.widgets import BECDockArea
 
 
 class DockConfig(ConnectionConfig):

bec_widgets/widgets/figure/figure.py

@@ -711,12 +711,6 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         qdarktheme.setup_theme(theme)
         self.setBackground("k" if theme == "dark" else "w")
         self.config.theme = theme
-        for plot in self.widget_list:
-            plot.set_x_label(plot.plot_item.getAxis("bottom").label.toPlainText())
-            plot.set_y_label(plot.plot_item.getAxis("left").label.toPlainText())
-            if plot.plot_item.titleLabel.text:
-                plot.set_title(plot.plot_item.titleLabel.text)
-            plot.set_legend_label_size()
 
     def _remove_by_coordinates(self, row: int, col: int) -> None:
         """

bec_widgets/widgets/figure/plots/plot_base.py

@@ -5,8 +5,6 @@ from typing import Literal, Optional
 import numpy as np
 import pyqtgraph as pg
 from pydantic import BaseModel, Field
-from qtpy import QT_VERSION
-from qtpy.QtGui import QFont, QFontDatabase, QFontInfo
 from qtpy.QtWidgets import QWidget
 
 from bec_widgets.utils import BECConnector, ConnectionConfig
@@ -14,14 +12,8 @@ from bec_widgets.utils import BECConnector, ConnectionConfig
 
 class AxisConfig(BaseModel):
     title: Optional[str] = Field(None, description="The title of the axes.")
-    title_size: Optional[int] = Field(None, description="The font size of the title.")
     x_label: Optional[str] = Field(None, description="The label for the x-axis.")
-    x_label_size: Optional[int] = Field(None, description="The font size of the x-axis label.")
     y_label: Optional[str] = Field(None, description="The label for the y-axis.")
-    y_label_size: Optional[int] = Field(None, description="The font size of the y-axis label.")
-    legend_label_size: Optional[int] = Field(
-        None, description="The font size of the legend labels."
-    )
     x_scale: Literal["linear", "log"] = Field("linear", description="The scale of the x-axis.")
     y_scale: Literal["linear", "log"] = Field("linear", description="The scale of the y-axis.")
     x_lim: Optional[tuple] = Field(None, description="The limits of the x-axis.")
@@ -58,7 +50,6 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
         "set_grid",
         "lock_aspect_ratio",
         "remove",
-        "set_legend_label_size",
     ]
 
     def __init__(
@@ -94,7 +85,6 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
             - y_scale: Literal["linear", "log"]
             - x_lim: tuple
             - y_lim: tuple
-            - legend_label_size: int
         """
         # Mapping of keywords to setter methods
         method_map = {
@@ -105,7 +95,6 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
             "y_scale": self.set_y_scale,
             "x_lim": self.set_x_lim,
             "y_lim": self.set_y_lim,
-            "legend_label_size": self.set_legend_label_size,
         }
         for key, value in kwargs.items():
             if key in method_map:
@@ -127,79 +116,34 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
 
         self.set(**{k: v for k, v in config_mappings.items() if v is not None})
 
-    def set_legend_label_size(self, size: int = None):
-        """
-        Set the font size of the legend.
-
-        Args:
-            size(int): Font size of the legend.
-        """
-        if not self.plot_item.legend:
-            return
-        if self.config.axis.legend_label_size or size:
-            if size:
-                self.config.axis.legend_label_size = size
-                scale = (
-                    size / 9
-                )  # 9 is the default font size of the legend, so we always scale it against 9
-                self.plot_item.legend.setScale(scale)
-
-    def get_text_color(self):
-        return "#FFF" if self.figure.config.theme == "dark" else "#000"
-
-    def set_title(self, title: str, size: int = None):
+    def set_title(self, title: str):
         """
         Set the title of the plot widget.
 
         Args:
             title(str): Title of the plot widget.
-            size(int): Font size of the title.
         """
-        if self.config.axis.title_size or size:
-            if size:
-                self.config.axis.title_size = size
-            style = {"color": self.get_text_color(), "size": f"{self.config.axis.title_size}pt"}
-        else:
-            style = {}
-        self.plot_item.setTitle(title, **style)
+        self.plot_item.setTitle(title)
         self.config.axis.title = title
 
-    def set_x_label(self, label: str, size: int = None):
+    def set_x_label(self, label: str):
         """
         Set the label of the x-axis.
 
         Args:
             label(str): Label of the x-axis.
-            size(int): Font size of the label.
         """
-        if self.config.axis.x_label_size or size:
-            if size:
-                self.config.axis.x_label_size = size
-            style = {
-                "color": self.get_text_color(),
-                "font-size": f"{self.config.axis.x_label_size}pt",
-            }
-        else:
-            style = {}
-        self.plot_item.setLabel("bottom", label, **style)
+        self.plot_item.setLabel("bottom", label)
         self.config.axis.x_label = label
 
-    def set_y_label(self, label: str, size: int = None):
+    def set_y_label(self, label: str):
         """
         Set the label of the y-axis.
 
         Args:
             label(str): Label of the y-axis.
-            size(int): Font size of the label.
         """
-        if self.config.axis.y_label_size or size:
-            if size:
-                self.config.axis.y_label_size = size
-            color = self.get_text_color()
-            style = {"color": color, "font-size": f"{self.config.axis.y_label_size}pt"}
-        else:
-            style = {}
-        self.plot_item.setLabel("left", label, **style)
+        self.plot_item.setLabel("left", label)
         self.config.axis.y_label = label
 
     def set_x_scale(self, scale: Literal["linear", "log"] = "linear"):

bec_widgets/widgets/figure/plots/waveform/waveform.py

@@ -54,7 +54,6 @@ class BECWaveform(BECPlotBase):
         "set_grid",
         "lock_aspect_ratio",
         "remove",
-        "set_legend_label_size",
     ]
     scan_signal_update = pyqtSignal()
 
@@ -402,7 +401,6 @@ class BECWaveform(BECPlotBase):
         self.config.curves[name] = curve.config
         if data is not None:
             curve.setData(data[0], data[1])
-        self.set_legend_label_size()
         return curve
 
     def _validate_signal_entries(

bec_widgets/widgets/text_box/text_box.py

@@ -1,127 +0,0 @@
-import re
-
-from pydantic import Field, field_validator
-from qtpy.QtWidgets import QTextEdit
-
-from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
-from bec_widgets.utils.colors import Colors
-
-
-class TextBoxConfig(ConnectionConfig):
-
-    theme: str = Field("dark", description="The theme of the figure widget.")
-    font_color: str = Field("#FFF", description="The font color of the text")
-    background_color: str = Field("#000", description="The background color of the widget.")
-    font_size: int = Field(16, description="The font size of the text in the widget.")
-    text: str = Field("", description="The text to display in the widget.")
-
-    @classmethod
-    @field_validator("theme")
-    def validate_theme(cls, v):
-        """Validate the theme of the figure widget."""
-        if v not in ["dark", "light"]:
-            raise ValueError("Theme must be either 'dark' or 'light'")
-        return v
-
-    _validate_font_color = field_validator("font_color")(Colors.validate_color)
-    _validate_background_color = field_validator("background_color")(Colors.validate_color)
-
-
-class TextBox(BECConnector, QTextEdit):
-
-    USER_ACCESS = ["set_color", "set_text", "set_font_size"]
-
-    def __init__(self, text: str = "", parent=None, client=None, config=None, gui_id=None):
-        if config is None:
-            config = TextBoxConfig(widget_class=self.__class__.__name__)
-        else:
-            if isinstance(config, dict):
-                config = TextBoxConfig(**config)
-            self.config = config
-        super().__init__(client=client, config=config, gui_id=gui_id)
-        QTextEdit.__init__(self, parent=parent)
-
-        self.config = config
-        self.setReadOnly(True)
-        self.setGeometry(self.rect())
-        self.set_color(self.config.background_color, self.config.font_color)
-        if not text:
-            text = "<h1>Welcome to the BEC Widget TextBox</h1><p>A widget that allows user to display text in plain and HTML format.</p><p>This is an example of displaying HTML text.</p>"
-        self.set_text(text)
-
-    def change_theme(self) -> None:
-        """
-        Change the theme of the figure widget.
-        """
-        if self.config.theme == "dark":
-            theme = "light"
-            font_color = "#000"
-            background_color = "#FFF"
-        else:
-            theme = "dark"
-            font_color = "#FFF"
-            background_color = "#000"
-        self.config.theme = theme
-        self.set_color(background_color, font_color)
-
-    def set_color(self, background_color: str, font_color: str) -> None:
-        """Set the background color of the widget.
-
-        Args:
-            background_color (str): The color to set the background in HEX.
-            font_color (str): The color to set the font in HEX.
-
-        """
-        self.config.background_color = background_color
-        self.config.font_color = font_color
-        self._update_stylesheet()
-
-    def set_font_size(self, size: int) -> None:
-        """Set the font size of the text in the widget.
-
-        Args:
-            size (int): The font size to set.
-        """
-        self.config.font_size = size
-        self._update_stylesheet()
-
-    def _update_stylesheet(self):
-        """Update the stylesheet of the widget."""
-        self.setStyleSheet(
-            f"background-color: {self.config.background_color}; color: {self.config.font_color}; font-size: {self.config.font_size}px"
-        )
-
-    def set_text(self, text: str) -> None:
-        """Set the text of the widget.
-
-        Args:
-            text (str): The text to set.
-        """
-        if self.is_html(text):
-            self.setHtml(text)
-        else:
-            self.setPlainText(text)
-        self.config.text = text
-
-    def is_html(self, text: str) -> bool:
-        """Check if the text contains HTML tags.
-
-        Args:
-            text (str): The text to check.
-
-        Returns:
-            bool: True if the text contains HTML tags, False otherwise.
-        """
-        return bool(re.search(r"<[a-zA-Z/][^>]*>", text))
-
-
-if __name__ == "__main__":
-    import sys
-
-    from qtpy.QtWidgets import QApplication
-
-    app = QApplication(sys.argv)
-
-    widget = TextBox()
-    widget.show()
-    sys.exit(app.exec())

docs/developer/developer.md

@@ -1,46 +1,18 @@
 (developer)=
-# Developer 
+# Development
 
-Welcome to the BEC Widgets developer guide! This section is intended for developers who want to contribute to the development of BEC Widgets.
+To contribute to the development of BEC Widgets, start by setting up the development environment:
 
-```{toctree}
----
-maxdepth: 2
-hidden: true
----
+1. **Clone the Repository**: 
+```bash
+git clone https://gitlab.psi.ch/bec/bec_widgets
+cd bec_widgets
+```
+2. **Install in Editable Mode**:
 
-getting_started/getting_started.md
-widgets/widgets.md
-api_reference/api_reference.md
+Installing the package in editable mode allows you to make changes to the code and test them in real-time.
+```bash
+pip install -e .[dev,pyqt6]
 ```
 
 
-***
-
-````{grid} 2
-:gutter: 5
-
-```{grid-item-card}
-:link: developer.getting_started
-:link-type: ref
-:img-top: /assets/rocket_launch_48dp.svg
-:text-align: center
-
-## Getting Started
-
-Learn how to install BEC Widgets and get started with the framework.
-```
-
-```{grid-item-card}
-:link: developer.widgets
-:link-type: ref
-:img-top: /assets/apps_48dp.svg
-:text-align: center
-
-## Widgets
-
-Learn about the building blocks of larger applications: widgets.
-```
-````
-
-

docs/developer/getting_started/development.md

@@ -1,27 +0,0 @@
-(developer.development)=
-# Development
-
-If you like to contribute to the development of BEC Widgets, you can follow the steps below to set up your development environment.
-BEC Widgets works in conjunction with [BEC](https://bec.readthedocs.io/en/latest/). 
-Therefore, we recommend that you install BEC first following the [developer instructions](https://bec.readthedocs.io/en/latest/developer/getting_started/install_developer_env.html) and include BEC Widgets. 
-
-If you already have a BEC environment set up, you can install BEC Widgets in editable mode into your BEC Python environment.
-
-**Prerequisites**
-1. **Python Version:** BEC Widgets requires Python version 3.10 or higher. Verify your Python version to ensure compatibility.
-2. **BEC Installation:** BEC Widgets works in conjunction with BEC. While BEC is a dependency and will be installed automatically, you can find more information about BEC and its installation process in the [BEC documentation](https://beamline-experiment-control.readthedocs.io/en/latest/).
-
-**Clone the Repository**: 
-```bash
-git clone https://gitlab.psi.ch/bec/bec_widgets
-cd bec_widgets
-```
-**Install in Editable Mode**:
-
-Please install the package in editable mode into your BEC Python environemnt. 
-```bash
-pip install -e '.[dev,pyqt6]'
-```
-This installs the package together with [PyQT6](https://www.riverbankcomputing.com/static/Docs/PyQt6/introduction.html). 
-
-

docs/developer/getting_started/getting_started.md

@@ -1,12 +0,0 @@
-(developer.getting_started)=
-# Getting Started
-This section provides valuable information for developers who want to contribute to the development of BEC Widgets. The guide will help you set up the development environment, understand the modular development concept of BEC Widgets, and contribute to the project.
-
-```{toctree}
----
-maxdepth: 2
-hidden: false
----
-
-development/
-```

docs/developer/widgets/widgets.md

@@ -1,12 +0,0 @@
-(developer.widgets)=
-# Widgets
-This section provides an introduction to the building blocks of BEC Widgets: widgets. Widgets are the basic components of the graphical user interface (GUI) and are used to create larger applications. We will cover key topics such as how to develop new widgets or how to customise existing widgets. For details on the already available widgets and their usage, please refer to user section about [widgets](#user.widgets)
-
-```{toctree}
----
-maxdepth: 2
-hidden: false
----
-
-how_to_develop_a_widget/
-```

docs/user/customisation.md

@@ -48,7 +48,7 @@ users to interact. BEC Widgets must be placed in the window:
 
 ```
 from qtpy.QWidgets import QMainWindow
-from bec_widgets.widgets.figure import BECFigure
+from bec_widgets.widgets import BECFigure
 
 window = QMainWindow()
 bec_figure = BECFigure(gui_id="my_gui_app_id")
@@ -78,7 +78,7 @@ Final example:
 ```
 import sys
 from qtpy.QtWidgets import QMainWindow, QApplication
-from bec_widgets.widgets.figure import BECFigure
+from bec_widgets.widgets import BECFigure
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
 
 # creation of the Qt application

docs/user/getting_started/installation.md

@@ -9,7 +9,7 @@ Before installing BEC Widgets, please ensure the following requirements are met:
 
 **Standard Installation**
 
-To install BEC Widgets using the pip package manager, execute the following command in your terminal for getting the default PyQT6 version into your python environment for BEC:
+To install BEC Widgets using the pip package manager, execute the following command in your terminal for getting the default PyQT6 version in your python environment:
 
 
 ```bash

docs/user/widgets/buttons.md

@@ -24,7 +24,7 @@ a `StopButton` within a GUI layout:
 
 ```python
 from qtpy.QtWidgets import QWidget, QVBoxLayout
-from bec_widgets.widgets.buttons import StopButton
+from bec_widgets.widgets import StopButton
 
 
 class MyGui(QWidget):

docs/user/widgets/text_box.md

@@ -1,33 +0,0 @@
-(user.widgets.text_box)=
-# [Text Box Widget](/api_reference/_autosummary/bec_widgets.cli.client.TextBox)
-**Purpose:**
-
-The Text Box Widget is a widget that allows you to display text within the BEC GUI. The widget can be used to display plain text or HTML text.
-
-**Key Features:**
-
-- set the text to display.
-- automatically detects if the text is plain text or HTML text.
-- set background color and font color.
-
-**Code example:**
-
-The following code snipped demonstrates how to create a `TextBox` widget using BEC Widgets within BEC.
-```python
-text_box = gui.add_dock().add_widget("TextBox")
-# set the text to display
-text_box.set_text("Hello, World!")
-# set the background color and font color
-text_box.set_color(backgroud_color="#FFF", font_color="#000")
-# set the text to display as HTML
-text_box.set_text("<h1>Welcome to BEC Widgets</h1><p>This is an example of displaying <strong>HTML</strong> text.</p>")
-```
-
-
-
-
-
-
-
-
-

docs/user/widgets/widgets.md

@@ -12,7 +12,6 @@ bec_figure/
 spiral_progress_bar/
 website/
 buttons/
-text_box/
 ```
 
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.64.2"
+version = "0.62.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [
@@ -25,6 +25,7 @@ dependencies = [
     "pyqtdarktheme",
     "black",              # needed for bw-generate-cli
     "isort",              # needed for bw-generate-cli
+    "termqt @ git+ssh://git@github.com:TerryGeng/termqt.git"
 ]
 
 
@@ -36,6 +37,7 @@ dev = [
     "pytest-xvfb",
     "coverage",
     "pytest-qt",
+    "isort",
     "fakeredis",
 ]
 pyqt5 = ["PyQt5>=5.9", "PyQtWebEngine>=5.9"]
@@ -48,7 +50,6 @@ Homepage = "https://gitlab.psi.ch/bec/bec_widgets"
 
 [project.scripts]
 bw-generate-cli = "bec_widgets.cli.generate_cli:main"
-bec-gui-server = "bec_widgets.cli.server:main"
 
 [tool.hatch.build.targets.wheel]
 include = ["*"]

tests/end-2-end/conftest.py

@@ -8,8 +8,7 @@ from bec_lib.endpoints import MessageEndpoints
 from bec_widgets.cli.client_utils import _start_plot_process
 from bec_widgets.cli.rpc_register import RPCRegister
 from bec_widgets.utils import BECDispatcher
-from bec_widgets.widgets.dock import BECDockArea
-from bec_widgets.widgets.figure import BECFigure
+from bec_widgets.widgets import BECDockArea, BECFigure
 
 
 # make threads check in autouse, **will be executed at the end**; better than

tests/unit_tests/test_bec_dock.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from bec_widgets.widgets.dock import BECDock, BECDockArea
+from bec_widgets.widgets import BECDock, BECDockArea
 
 from .client_mocks import mocked_client
 

tests/unit_tests/test_bec_figure.py

@@ -3,7 +3,7 @@
 import numpy as np
 import pytest
 
-from bec_widgets.widgets.figure import BECFigure
+from bec_widgets.widgets import BECFigure
 from bec_widgets.widgets.figure.plots.image.image import BECImageShow
 from bec_widgets.widgets.figure.plots.motor_map.motor_map import BECMotorMap
 from bec_widgets.widgets.figure.plots.waveform.waveform import BECWaveform

tests/unit_tests/test_generate_cli_client.py

@@ -97,3 +97,17 @@ def test_client_generator_with_black_formatting():
     generated_output_formatted = isort.code(generated_output_formatted)
 
     assert expected_output_formatted == generated_output_formatted
+
+
+def test_client_generator_classes():
+    generator = ClientGenerator()
+    out = generator.get_rpc_classes("bec_widgets")
+    assert list(out.keys()) == ["connector_classes", "top_level_classes"]
+    connector_cls_names = [cls.__name__ for cls in out["connector_classes"]]
+    top_level_cls_names = [cls.__name__ for cls in out["top_level_classes"]]
+
+    assert "BECFigure" in connector_cls_names
+    assert "BECWaveform" in connector_cls_names
+    assert "BECDockArea" in top_level_cls_names
+    assert "BECFigure" in top_level_cls_names
+    assert "BECWaveform" not in top_level_cls_names

tests/unit_tests/test_plot_base.py

@@ -1,8 +1,5 @@
 # pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
-from unittest import mock
-
 import pytest
-from qtpy.QtGui import QFontInfo
 
 from .client_mocks import mocked_client
 from .test_bec_figure import bec_figure
@@ -40,30 +37,6 @@ def test_plot_base_axes_by_separate_methods(bec_figure):
     assert plot_base.plot_item.ctrl.logXCheck.isChecked() == True
     assert plot_base.plot_item.ctrl.logYCheck.isChecked() == True
 
-    # Check the font size by mocking the set functions
-    # I struggled retrieving it from the QFont object directly
-    # thus I mocked the set functions to check internally the functionality
-    with (
-        mock.patch.object(plot_base.plot_item, "setLabel") as mock_set_label,
-        mock.patch.object(plot_base.plot_item, "setTitle") as mock_set_title,
-    ):
-        plot_base.set_x_label("Test x Label", 20)
-        plot_base.set_y_label("Test y Label", 16)
-        assert mock_set_label.call_count == 2
-        assert plot_base.config.axis.x_label_size == 20
-        assert plot_base.config.axis.y_label_size == 16
-        col = plot_base.get_text_color()
-        calls = []
-        style = {"color": col, "font-size": "20pt"}
-        calls.append(mock.call("bottom", "Test x Label", **style))
-        style = {"color": col, "font-size": "16pt"}
-        calls.append(mock.call("left", "Test y Label", **style))
-        assert mock_set_label.call_args_list == calls
-        plot_base.set_title("Test Title", 16)
-        style = {"color": col, "size": "16pt"}
-        call = mock.call("Test Title", **style)
-        assert mock_set_title.call_args == call
-
 
 def test_plot_base_axes_added_by_kwargs(bec_figure):
     plot_base = bec_figure.add_widget(widget_type="PlotBase", widget_id="test_plot")

tests/unit_tests/test_plugin_utils.py

@@ -1,14 +0,0 @@
-from bec_widgets.utils.plugin_utils import get_rpc_classes
-
-
-def test_client_generator_classes():
-    out = get_rpc_classes("bec_widgets")
-    assert list(out.keys()) == ["connector_classes", "top_level_classes"]
-    connector_cls_names = [cls.__name__ for cls in out["connector_classes"]]
-    top_level_cls_names = [cls.__name__ for cls in out["top_level_classes"]]
-
-    assert "BECFigure" in connector_cls_names
-    assert "BECWaveform" in connector_cls_names
-    assert "BECDockArea" in top_level_cls_names
-    assert "BECFigure" in top_level_cls_names
-    assert "BECWaveform" not in top_level_cls_names

tests/unit_tests/test_scan_control.py

@@ -5,7 +5,7 @@ import pytest
 from qtpy.QtWidgets import QLineEdit
 
 from bec_widgets.utils.widget_io import WidgetIO
-from bec_widgets.widgets.scan_control import ScanControl
+from bec_widgets.widgets import ScanControl
 from tests.unit_tests.test_msgs.available_scans_message import available_scans_message
 
 

tests/unit_tests/test_spiral_progress_bar.py

@@ -5,7 +5,7 @@ from bec_lib.endpoints import MessageEndpoints
 from pydantic import ValidationError
 
 from bec_widgets.utils import Colors
-from bec_widgets.widgets.spiral_progress_bar import SpiralProgressBar
+from bec_widgets.widgets import SpiralProgressBar
 from bec_widgets.widgets.spiral_progress_bar.ring import RingConfig, RingConnections
 from bec_widgets.widgets.spiral_progress_bar.spiral_progress_bar import SpiralProgressBarConfig
 

tests/unit_tests/test_stop_button.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from bec_widgets.widgets.buttons import StopButton
+from bec_widgets.widgets import StopButton
 
 from .client_mocks import mocked_client
 

tests/unit_tests/test_text_box_widget.py

@@ -1,55 +0,0 @@
-import re
-from unittest import mock
-
-import pytest
-
-from bec_widgets.widgets.text_box.text_box import TextBox
-
-from .client_mocks import mocked_client
-
-
-@pytest.fixture
-def text_box_widget(qtbot, mocked_client):
-    widget = TextBox(client=mocked_client)
-    qtbot.addWidget(widget)
-    qtbot.waitExposed(widget)
-    yield widget
-    widget.close()
-
-
-def test_textbox_widget(text_box_widget):
-    """Test the TextBox widget."""
-    text = "Hello World!"
-    text_box_widget.set_text(text)
-    assert text_box_widget.toPlainText() == text
-
-    text_box_widget.set_color("#FFDDC1", "#123456")
-    text_box_widget.set_font_size(20)
-    assert (
-        text_box_widget.styleSheet() == "background-color: #FFDDC1; color: #123456; font-size: 20px"
-    )
-    text_box_widget.set_color("white", "blue")
-    text_box_widget.set_font_size(14)
-    assert text_box_widget.styleSheet() == "background-color: white; color: blue; font-size: 14px"
-    text = "<h1>Welcome to PyQt6</h1><p>This is an example of displaying <strong>HTML</strong> text.</p>"
-    with mock.patch.object(text_box_widget, "setHtml") as mocked_set_html:
-        text_box_widget.set_text(text)
-        assert mocked_set_html.call_count == 1
-        assert mocked_set_html.call_args == mock.call(text)
-
-
-def test_textbox_change_theme(text_box_widget):
-    """Test change theme functionaility"""
-    # Default is dark theme
-    text_box_widget.change_theme()
-    assert text_box_widget.config.theme == "light"
-    assert (
-        text_box_widget.styleSheet()
-        == f"background-color: #FFF; color: #000; font-size: {text_box_widget.config.font_size}px"
-    )
-    text_box_widget.change_theme()
-    assert text_box_widget.config.theme == "dark"
-    assert (
-        text_box_widget.styleSheet()
-        == f"background-color: #000; color: #FFF; font-size: {text_box_widget.config.font_size}px"
-    )

tests/unit_tests/test_waveform1d.py

@@ -1,5 +1,5 @@
 # pylint: disable=missing-function-docstring, missing-module-docstring, unused-import
-from unittest import mock
+from unittest.mock import MagicMock
 
 import numpy as np
 import pytest
@@ -56,12 +56,8 @@ def test_create_waveform1D_by_config(bec_figure):
         "col": 0,
         "axis": {
             "title": "Widget 1",
-            "title_size": None,
             "x_label": None,
-            "x_label_size": None,
             "y_label": None,
-            "y_label_size": None,
-            "legend_label_size": None,
             "x_scale": "linear",
             "y_scale": "linear",
             "x_lim": (1, 10),
@@ -197,18 +193,6 @@ def test_add_curve(bec_figure):
     assert c1.config.source == "scan_segment"
 
 
-def test_change_legend_font_size(bec_figure):
-    plot = bec_figure.add_plot()
-
-    w1 = plot.add_curve_scan(x_name="samx", y_name="bpm4i")
-    my_func = plot.plot_item.legend
-    with mock.patch.object(my_func, "setScale") as mock_set_scale:
-        plot.set_legend_label_size(18)
-        assert plot.config.axis.legend_label_size == 18
-        assert mock_set_scale.call_count == 1
-        assert mock_set_scale.call_args == mock.call(2)
-
-
 def test_remove_curve(bec_figure):
     w1 = bec_figure.add_plot()
 
@@ -422,10 +406,10 @@ def test_scan_update(bec_figure, qtbot):
         "scan_id": 1,
     }
     # Mock scan_storage.find_scan_by_ID
-    mock_scan_data_waveform = mock.MagicMock()
+    mock_scan_data_waveform = MagicMock()
     mock_scan_data_waveform.data = {
         device_name: {
-            entry: mock.MagicMock(val=[msg_waveform["data"][device_name][entry]["value"]])
+            entry: MagicMock(val=[msg_waveform["data"][device_name][entry]["value"]])
             for entry in msg_waveform["data"][device_name]
         }
         for device_name in msg_waveform["data"]
@@ -446,12 +430,12 @@ def test_scan_history_with_val_access(bec_figure, qtbot):
     c1 = w1.add_curve_scan(x_name="samx", y_name="bpm4i")
 
     mock_scan_data = {
-        "samx": {"samx": mock.MagicMock(val=np.array([1, 2, 3]))},  # Use mock.MagicMock for .val
-        "bpm4i": {"bpm4i": mock.MagicMock(val=np.array([4, 5, 6]))},  # Use mock.MagicMock for .val
+        "samx": {"samx": MagicMock(val=np.array([1, 2, 3]))},  # Use MagicMock for .val
+        "bpm4i": {"bpm4i": MagicMock(val=np.array([4, 5, 6]))},  # Use MagicMock for .val
     }
 
-    mock_scan_storage = mock.MagicMock()
-    mock_scan_storage.find_scan_by_ID.return_value = mock.MagicMock(data=mock_scan_data)
+    mock_scan_storage = MagicMock()
+    mock_scan_storage.find_scan_by_ID.return_value = MagicMock(data=mock_scan_data)
     w1.queue.scan_storage = mock_scan_storage
 
     fake_scan_id = "fake_scan_id"
@@ -480,10 +464,10 @@ def test_scatter_2d_update(bec_figure, qtbot):
     }
     msg_metadata = {"scan_name": "line_scan"}
 
-    mock_scan_data = mock.MagicMock()
+    mock_scan_data = MagicMock()
     mock_scan_data.data = {
         device_name: {
-            entry: mock.MagicMock(val=msg["data"][device_name][entry]["value"])
+            entry: MagicMock(val=msg["data"][device_name][entry]["value"])
             for entry in msg["data"][device_name]
         }
         for device_name in msg["data"]