Migrate to PySide6 (#1601)

Co-authored-by: Martin Koerner <[email protected]>

Author: greghope667

.github/workflows/ci.yml

@@ -207,7 +207,8 @@ jobs:
         run: setup_pip_options
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
+
       # Test {{{
 
       - name: Run tests
@@ -262,7 +263,8 @@ jobs:
         run: setup_osx_python '3.9'
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
+
       # Test {{{
 
       - name: Run tests
@@ -323,7 +325,8 @@ jobs:
         run: setup_pip_options
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
+
       # Test {{{
 
       - name: Run tests
@@ -379,7 +382,8 @@ jobs:
         run: setup_pip_options
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
+
       # Test {{{
 
       - name: Run tests
@@ -435,7 +439,8 @@ jobs:
         run: setup_pip_options
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/test.txt        
+
       # Test {{{
 
       - name: Run tests
@@ -490,8 +495,15 @@ jobs:
       - name: Setup pip options
         run: setup_pip_options
 
+      - name: Install system dependencies
+        run: apt_get_install libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0
+
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/dist_extra_gui_qt.txt -r reqs/test.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/dist.txt -r reqs/dist_extra_gui_qt.txt -r reqs/test.txt        
+
+      - name: Build Resources
+        run: python setup.py build_resources
+
       - name: Build UI
         run: python setup.py build_ui
 
@@ -553,7 +565,8 @@ jobs:
         run: setup_pip_options
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/packaging.txt -r reqs/setup.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/packaging.txt -r reqs/setup.txt        
+
       - name: Patch version
         id: set_version
         run: |
@@ -603,7 +616,7 @@ jobs:
 
       - name: List cache contents
         run: list_cache
-  
+
     outputs:
       version: ${{ steps.set_version.outputs.version }}
   # }}}
@@ -646,10 +659,11 @@ jobs:
         run: setup_pip_options
 
       - name: Install system dependencies
-        run: apt_get_install libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev
+        run: apt_get_install libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/build.txt -r reqs/setup.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/build.txt -r reqs/setup.txt        
+
       - name: Patch version
         id: set_version
         run: |
@@ -718,7 +732,8 @@ jobs:
         run: setup_osx_python '3.9'
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/build.txt -r reqs/setup.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/build.txt -r reqs/setup.txt        
+
       - name: Patch version
         id: set_version
         run: |
@@ -793,7 +808,8 @@ jobs:
         run: setup_pip_options
 
       - name: Setup Python environment
-        run: setup_python_env -c reqs/constraints.txt -r reqs/build.txt -r reqs/setup.txt
+        run: setup_python_env -c reqs/constraints.txt -r reqs/build.txt -r reqs/setup.txt        
+
       - name: Patch version
         id: set_version
         run: |
@@ -876,6 +892,13 @@ jobs:
         with:
           path: dist
 
+      - name: Publish GitHub release (${{ needs.analyze.outputs.release_type }})
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          RELEASE_TYPE: ${{ needs.analyze.outputs.release_type }}
+          RELEASE_VERSION: ${{ needs.test_packaging.outputs.version }}
+        run: publish_github_release
+
       - name: Publish PyPI release
         if: needs.analyze.outputs.release_type == 'tagged'
         env:
@@ -885,13 +908,6 @@ jobs:
           # Optional: twine will fallback to default if empty.
           TWINE_REPOSITORY_URL: ${{ secrets.PYPI_URL }}
         run: publish_pypi_release
-
-      - name: Publish GitHub release (${{ needs.analyze.outputs.release_type }})
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          RELEASE_TYPE: ${{ needs.analyze.outputs.release_type }}
-          RELEASE_VERSION: ${{ needs.test_packaging.outputs.version }}
-        run: publish_github_release
   # }}}
 
 # vim: foldmethod=marker foldlevel=0

.github/workflows/ci/helpers.sh

@@ -114,8 +114,8 @@ setup_python_env()
   run_eval "echo PYTHONUSERBASE='$PYTHONUSERBASE' >>\$GITHUB_ENV"
   if [ ! -e "$python_userbase" ]
   then
-    get_base_devel --no-warn-script-location --user || die
-    install_wheels --no-warn-script-location --user "$@" || die
+    get_base_devel --no-warn-script-location || die
+    install_wheels --no-warn-script-location "$@" || die
     if [ "$RUNNER_OS" = 'Windows' ]
     then
       run rm -rf "$python_userbase"/Python*/Scripts

.github/workflows/ci/skiplist_default.txt

@@ -9,8 +9,6 @@ CONTRIBUTING.md
 NEWS.md
 README.md
 doc/*
-launch.bat
-launch.sh
 linux/README.md
 linux/packpack.mk
 linux/packpack.sh

.github/workflows/ci/workflow_template.yml

@@ -131,13 +131,14 @@ jobs:
         run: setup_osx_python '<@ j.python @>'
 
       <% endif %>
-      <% if j.type == 'build' and j.os == 'Linux' %>
+      <% if j.type in ['build', 'test_gui_qt'] and j.os == 'Linux' %>
       - name: Install system dependencies
-        run: apt_get_install libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev
+        run: apt_get_install libdbus-1-dev libdbus-glib-1-dev libudev-dev libusb-1.0-0-dev libegl-dev libxkbcommon-x11-0
 
       <% endif %>
       - name: Setup Python environment
         run: setup_python_env -c reqs/constraints.txt<% for r in j.reqs %> -r <@ r @><% endfor %>
+        
 
       <% if j.type in ['build', 'test_packaging'] %>
       - name: Patch version
@@ -150,6 +151,9 @@ jobs:
 
       <% endif %>
       <% if j.type == 'test_gui_qt' %>
+      - name: Build Resources
+        run: python setup.py build_resources
+
       - name: Build UI
         run: python setup.py build_ui
 
@@ -260,7 +264,7 @@ jobs:
       - name: List cache contents
         run: list_cache
     <% if j.type == 'test_packaging' %>
-  
+
     outputs:
       version: ${{ steps.set_version.outputs.version }}
     <% endif %>

.gitignore

@@ -33,4 +33,9 @@ __pycache__/
 # macOS
 .DS_Store
 
+# Virtual environments
+/.venv/
+/venv/
+
+
 # vim: ft=cfg

MANIFEST.in

@@ -9,8 +9,6 @@ recursive-include doc *.png
 recursive-include doc *.svg
 recursive-include doc *.py
 recursive-include doc *.txt
-include launch.bat
-include launch.sh
 include linux/*
 include linux/appimage/*
 include news.d/api/*
@@ -21,9 +19,9 @@ include osx/*
 include osx/app_resources/*
 include osx/dmg_resources/*
 include plover/assets/*
+include plover/gui_qt/*.qrc
 include plover/gui_qt/*.ui
 include plover/gui_qt/resources/*.png
-include plover/gui_qt/resources/*.qrc
 include plover/gui_qt/resources/*.svg
 include plover/messages/*/LC_MESSAGES/*.po
 include plover/messages/plover.pot
@@ -35,11 +33,8 @@ include test/*.py
 include test/gui_qt/*.py
 include tox.ini
 include windows/*
-# Exclude: CI/Git/GitHub specific files,
-# as well as generated Python files (UI).
-exclude .gitignore
+# without first including it, exluding .readthedocs.yml results in a warning when running locally
+include .readthedocs.yml
 exclude .readthedocs.yml
 exclude plover/gui_qt/*_rc.py
 exclude plover/gui_qt/*_ui.py
-exclude plover/gui_qt/.gitignore
-prune .github

doc/conf.py

@@ -6,7 +6,7 @@
 copyright = "Open Steno Project"
 author = copyright
 
-release = "4.0.0"
+release = "5.0.0.dev1"
 version = release
 
 # -- General configuration ---------------------------------------------------

doc/developer_guide.md

@@ -2,38 +2,52 @@
 
 You need Python >= 3.8 installed, and you need [tox](https://pypi.org/project/tox/) >= 4.0.
 
-Using tox takes care of all the details of creating and managing an isolated
-virtual environment, installing the necessary dependencies, and isolating
-testsuite runs.
+Tox simplifies the process of creating and managing isolated virtual environments,
+handling dependency installation, and running the test suite in isolation. This
+ensures a clean and consistent testing environment.
 
-The command for using tox is: `tox r {-e envlist} {-- arguments}`. Use `tox -a
+However, it is still recommended to install and run tox within a Python virtual
+environment created using tools like [venv](https://docs.python.org/3/library/venv.html).
+This helps keep your global Python environment clean, avoids project conflicts, and
+isolates tox and its dependencies.
+
+The command for using tox is: `tox {-e envlist} {-- arguments}`. Use `tox -a
 -v` to get a list of available environments.
 
 The same virtual environment is reused by the following tox environments:
 
-- `tox r -e test -- ARGS`: run the testsuite. This is the default environment
+- `tox -e test -- ARGS`: run the testsuite. This is the default environment
   when not provided.
-- `tox r -e launch -- ARGS`: run Plover from source.
-- `tox r -e setup -- COMMAND`: run `./setup.py COMMAND`.
-- `tox r -e packaging_checks`: run the same packaging checks as the CI (add `--
+  
+  Example: `tox -e test -- test/gui_qt`
+- `tox -e launch -- ARGS`: run Plover from source.
+
+  Example: `tox -e launch -- -l debug`
+- `tox -e setup -- COMMAND`: run `./setup.py COMMAND` to create a binary 
+  distribution. See also section below.
+
+  Example: `tox -e setup -- bdist_appimage`
+- `tox -e packaging_checks`: run the same packaging checks as the CI (add `--
 -n` to see a dry-run of the exact checks).
-- `tox r -e plugins_install`: install the distribution plugins (or the specified
-  plugins when run with `tox -e plugins_install -- REQS`). Note that this does
-  not use the plugins manager for installing.
-- `tox r -e release_prepare -- NEW_VERSION`: execute all the steps necessary for
+- `tox -e plugins_install -- ARGS`: install the plugins specified in `ARGS`, where
+  plugins are separated by space. You can also specify plugin versions. Note that
+  this process uses pip directly for installation, not the plugins manager.
+
+  Example: `tox -e plugins_install -- some_plugin==1.0.0 another_plugin`
+- `tox -e release_prepare -- NEW_VERSION`: execute all the steps necessary for
   preparing a new release: patch the version to `NEW_VERSION` and update
   `NEWS.md`, staging all the changes for review.
-- `tox r -e release_finalize`: finalize the release: commit the staged changes,
+- `tox -e release_finalize`: finalize the release: commit the staged changes,
   create an annotated tag, and print the git command necessary for pushing the
   release to GitHub.
 
-The actual virtual environment lives in `.tox/dev`, and can be ["activated" like
+The virtual environment created by tox lives in `.tox/dev`, and can be [activated like
 any other virtual environment](https://virtualenv.pypa.io/en/latest/user_guide.html#activators).
 
 The configuration also provides support for lightweight tests only environment:
 `pyX`, where `X` is the version of the Python interpreter to use. E.g. running
-`tox r -e 'py3,py36,py37,py38,py39` will execute the testsuite for each version of Python we
-support.
+`tox -e 'py3,py36,py37,py38,py39` will execute the testsuite for each version
+of Python we support.
 
 # Creating a binary distribution
 

doc/plugin-dev/gui_tools.md

@@ -5,12 +5,13 @@ as follows:
 
 ```python
 from setuptools import setup
-from plover_build_utils.setup import BuildPy, BuildUi
+from plover_build_utils.setup import BuildPy, BuildResources, BuildUi
 
 BuildPy.build_dependencies.append("build_ui")
-BuildUi.hooks = ["plover_build_utils.pyqt:fix_icons"]
+BuildPy.build_dependencies.append("build_resources")
 CMDCLASS = {
   "build_py": BuildPy,
+  "build_resources": BuildResources,
   "build_ui": BuildUi,
 }
 

linux/appimage/blacklist.txt

@@ -31,37 +31,33 @@
 # Plover.
 :usr/lib/python${pyversion}/site-packages/plover
   gui_qt/*.ui
-  gui_qt/resources
   messages/**/*.po
   messages/plover.pot
 
-# PyQt5.
+  # PySide6.
 :usr/bin
-  pylupdate5
-  pyrcc5
-  pyuic5
-:usr/lib/python${pyversion}/site-packages/PyQt5
+  pylupdate6
+  pyuic6
+:usr/lib/python${pyversion}/site-packages/PySide6
   **/*Designer*
   **/*[Hh]elp*
   **/*[Qq]ml*
   **/*[Qq]uick*
   **/*Test*
-  **/*[Ww]ayland*
   **/*[Ww]eb[Ee]ngine*
   bindings
-  Qt5/plugins/egldeviceintegrations
-  Qt5/plugins/geoservices
-  Qt5/plugins/platforms/libqeglfs.so
-  Qt5/plugins/platforms/libqlinuxfb.so
-  Qt5/plugins/platforms/libqminimal.so
-  Qt5/plugins/platforms/libqminimalegl.so
-  Qt5/plugins/platforms/libqoffscreen.so
-  Qt5/plugins/platforms/libqvnc.so
-  Qt5/plugins/platforms/libqwebgl.so
-  Qt5/plugins/sceneparsers
-  Qt5/plugins/webview
+  Qt6/plugins/egldeviceintegrations
+  Qt6/plugins/geoservices
+  Qt6/plugins/platforms/libqeglfs.so
+  Qt6/plugins/platforms/libqlinuxfb.so
+  Qt6/plugins/platforms/libqminimal.so
+  Qt6/plugins/platforms/libqminimalegl.so
+  Qt6/plugins/platforms/libqoffscreen.so
+  Qt6/plugins/platforms/libqvnc.so
+  Qt6/plugins/platforms/libqwebgl.so
+  Qt6/plugins/sceneparsers
+  Qt6/plugins/webview
   pylupdate*
-  pyrcc*
   uic
 
 # vim: ft=config