diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 32fc8fc2..0ba62168 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -148,7 +148,7 @@ tests: - *clone-repos - *install-os-packages - *install-repos - - pip install -e .[dev,pyqt6] + - pip install -e .[dev,pyside6] - coverage run --source=./bec_widgets -m pytest -v --junitxml=report.xml --maxfail=2 --random-order --full-trace ./tests/unit_tests - coverage report - coverage xml @@ -172,7 +172,6 @@ test-matrix: - "3.12" QT_PCKG: - "pyside6" - - "pyqt6" stage: AdditionalTests needs: [] @@ -211,7 +210,7 @@ end-2-end-conda: - cd ../ - pip install -e ./ophyd_devices - - pip install -e .[dev,pyqt6] + - pip install -e .[dev,pyside6] - cd ./tests/end-2-end - pytest -v --start-servers --flush-redis --random-order diff --git a/README.md b/README.md index e02ab8ae..d7277dd4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # BEC Widgets +**⚠️ Important Notice:** + +🚨 **PyQt6 is no longer supported** due to incompatibilities with Qt Designer. Please use **PySide6** instead. 🚨 + BEC Widgets is a GUI framework designed for interaction with [BEC (Beamline Experiment Control)](https://gitlab.psi.ch/bec/bec). + ## Installation Use the package manager [pip](https://pip.pypa.io/en/stable/) to install BEC Widgets: ```bash -pip install bec_widgets PyQt6 +pip install bec_widgets[pyside6] ``` For development purposes, you can clone the repository and install the package locally in editable mode: @@ -14,22 +19,12 @@ For development purposes, you can clone the repository and install the package l ```bash git clone https://gitlab.psi.ch/bec/bec-widgets cd bec_widgets -pip install -e .[dev,pyqt6] +pip install -e .[dev,pyside6] ``` -BEC Widgets currently supports both Pyside6 and PyQt6, however, no default distribution is specified. As a result, users must install one of the supported -Python Qt distributions manually. +BEC Widgets now **only supports PySide6**. Users must manually install PySide6 as no default Qt distribution is +specified. -To select a specific Python Qt distribution, install the package with an additional tag: - -```bash -pip install bec_widgets[pyqt6] -``` -or - -```bash -pip install bec_widgets[pyside6] -``` ## Documentation Documentation of BEC Widgets can be found [here](https://bec-widgets.readthedocs.io/en/latest/). The documentation of the BEC can be found [here](https://bec.readthedocs.io/en/latest/). @@ -39,7 +34,7 @@ Documentation of BEC Widgets can be found [here](https://bec-widgets.readthedocs All commits should use the Angular commit scheme: > #### Angular Commit Message Header -> +> > ``` > (): > │ │ │ @@ -53,13 +48,13 @@ All commits should use the Angular commit scheme: > │ > └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test > ``` -> +> > The `` and `` fields are mandatory, the `()` field is optional. > ##### Type -> +> > Must be one of the following: -> +> > * **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) > * **ci**: Changes to our CI configuration files and scripts (examples: CircleCi, SauceLabs) > * **docs**: Documentation only changes @@ -71,4 +66,5 @@ All commits should use the Angular commit scheme: ## License -[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/) \ No newline at end of file +[BSD-3-Clause](https://choosealicense.com/licenses/bsd-3-clause/) + diff --git a/docs/user/getting_started/installation.md b/docs/user/getting_started/installation.md index d1f6a3a7..55e63ad7 100644 --- a/docs/user/getting_started/installation.md +++ b/docs/user/getting_started/installation.md @@ -9,25 +9,24 @@ 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 PySide6 version into your python environment for BEC: -```bash -pip install 'bec_widgets[pyqt6]' -``` - -In case you want to use Pyside6, you can install it by using the following command: - ```bash pip install 'bec_widgets[pyside6]' ``` **Troubleshooting** -If you encounter issues during installation, particularly with PyQt, try purging the pip cache: +If you encounter issues during installation, particularly with Qt, try purging the pip cache: ```bash pip cache purge ``` This can resolve conflicts or issues with package installations. + +```{warning} +At the moment PyQt6 is no longer officially supported by BEC Widgets due to incompatibilities with Qt Designer. Please use PySide6 instead. +``` diff --git a/pyproject.toml b/pyproject.toml index d3a2c064..ceb7833e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,6 @@ dev = [ "pytest-xvfb~=3.0", "pytest~=8.0", ] -pyqt6 = ["PyQt6>=6.7", "PyQt6-WebEngine>=6.7"] pyside6 = ["PySide6==6.7.2"] [project.urls]