Merge remote-tracking branch 'origin/main' into pyqt6-migration

Author: mkrnr

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-<!-- First time contributors: Take a moment to review https://github.com/openstenoproject/plover/blob/master/doc/developer_guide.md! -->
+<!-- First time contributors: Take a moment to review https://github.com/openstenoproject/plover/blob/main/doc/developer_guide.md! -->
 <!-- Remove sections if not applicable -->
 
 ## Summary of changes
@@ -9,4 +9,4 @@ Closes <!-- issue number here -->
 
 ### Pull Request Checklist
 - [ ] Changes have tests
-- [ ] News fragment added in news.d. See [documentation](https://github.com/openstenoproject/plover/blob/master/doc/developer_guide.md#making-a-pull-request) for details
+- [ ] News fragment added in news.d. See [documentation](https://github.com/openstenoproject/plover/blob/main/doc/developer_guide.md#making-a-pull-request) for details

.github/RELEASE_DRAFT_FILTER.lua

@@ -10,13 +10,13 @@ return {
         release_count = release_count + 1
       end
       if elem.level < 3 or release_count > 1 then
-        return pandoc.Null()
+        return {}
       end
       return elem
     end,
     Block = function (elem)
       if release_count > 1 then
-        return pandoc.Null()
+        return {}
       end
       return elem
     end,

.github/workflows/ci.yml

@@ -179,7 +179,7 @@ EOF
   run pandoc --from=gfm --to=gfm \
     --lua-filter=.github/RELEASE_DRAFT_FILTER.lua \
     --template=.github/RELEASE_DRAFT_TEMPLATE.md \
-    --base-header-level=2 --wrap=none \
+    --shift-heading-level-by=2 --wrap=none \
     --variable="version:$RELEASE_VERSION" \
     --output=notes.md \
     "$notes_body" || die

.github/workflows/ci/helpers.sh

@@ -1,29 +1,29 @@
 cache_epoch: 0 # <- increase number to clear cache.
 
-action_cache: actions/cache@v3
-action_checkout: actions/checkout@v3
-action_setup_python: actions/setup-python@v4
-action_upload_artifact: actions/upload-artifact@v3
-action_download_artifact: actions/download-artifact@v3
+action_cache: actions/cache@v4
+action_checkout: actions/checkout@v4
+action_setup_python: actions/setup-python@v5
+action_upload_artifact: actions/upload-artifact@v4
+action_download_artifact: actions/download-artifact@v4
 
 skippy_enabled: true
 
 vars:
   - &dist_linux
     variant: Linux
-    python: '3.9'
+    python: "3.9"
     os: Linux
-    platform: ubuntu-22.04
+    platform: ubuntu-24.04
 
   - &dist_macos
     variant: macOS
-    python: '3.9'
+    python: "3.9"
     os: macOS
-    platform: macos-12
+    platform: macos-15
 
   - &dist_win
     variant: Windows
-    python: '3.9'
+    python: "3.9"
     os: Windows
     platform: windows-2022
 
@@ -32,67 +32,63 @@ vars:
     platform: ubuntu-latest
 
 jobs:
-
   # Platform tests.
   - &test
     <<: *dist_linux
     type: test
-    reqs: ['dist', 'test']
-    skiplists: ['job_test', 'os_linux']
+    reqs: ["dist", "test"]
+    skiplists: ["job_test", "os_linux"]
     test_args: -p no:pytest-qt --ignore=test/gui_qt
   - <<: *test
     <<: *dist_macos
-    cache_extra_deps: ['osx/deps.sh']
-    skiplists: ['job_test', 'os_macos']
+    cache_extra_deps: ["osx/deps.sh"]
+    skiplists: ["job_test", "os_macos"]
   - <<: *test
     <<: *dist_win
-    skiplists: ['job_test', 'os_windows']
+    skiplists: ["job_test", "os_windows"]
 
   # Python tests.
   - &python_test
     <<: *test
     <<: *dist_other
-    variant: Python 3.7
-    python: '3.7'
-    skiplists: ['job_test', 'os_linux', 'os_macos', 'os_windows']
-  - <<: *python_test
     variant: Python 3.8
-    python: '3.8'
+    python: "3.8"
+    skiplists: ["job_test", "os_linux", "os_macos", "os_windows"]
   - <<: *python_test
     variant: Python 3.10
-    python: '3.10'
+    python: "3.10"
 
   # Qt GUI tests.
   - <<: *test
     type: test_gui_qt
     variant: Qt GUI
-    reqs: ['dist', 'dist_extra_gui_qt', 'test']
-    skiplists: ['job_test_gui_qt']
+    reqs: ["dist", "dist_extra_gui_qt", "test"]
+    skiplists: ["job_test_gui_qt"]
     test_args: test/gui_qt
 
   # Packaging tests.
   - <<: *dist_other
     type: test_packaging
     variant: Packaging
-    python: '3.9'
-    reqs: ['packaging', 'setup']
-    skiplists: ['job_test_packaging']
+    python: "3.9"
+    reqs: ["packaging", "setup"]
+    skiplists: ["job_test_packaging"]
 
   # Platform builds.
   - &build
     <<: *dist_linux
     type: build
     needs: [test_linux]
-    reqs: ['build', 'setup']
-    cache_extra_deps: ['reqs/dist_*.txt', 'linux/appimage/deps.sh']
-    skiplists: ['job_build', 'os_linux']
+    reqs: ["build", "setup"]
+    cache_extra_deps: ["reqs/dist_*.txt", "linux/appimage/deps.sh"]
+    skiplists: ["job_build", "os_linux"]
   - <<: *build
     <<: *dist_macos
     needs: [test_macos]
-    cache_extra_deps: ['reqs/dist_*.txt', 'osx/deps.sh']
-    skiplists: ['job_build', 'os_macos']
+    cache_extra_deps: ["reqs/dist_*.txt", "osx/deps.sh"]
+    skiplists: ["job_build", "os_macos"]
   - <<: *build
     <<: *dist_win
     needs: [test_windows]
-    cache_extra_deps: ['reqs/dist_*.txt', 'windows/dist_deps.sh']
-    skiplists: ['job_build', 'os_windows']
+    cache_extra_deps: ["reqs/dist_*.txt", "windows/dist_deps.sh"]
+    skiplists: ["job_build", "os_windows"]

.github/workflows/ci/workflow_context.yml

@@ -3,11 +3,15 @@ name: CI
 on:
   push:
     branches:
-      - '*'
+      - 'main'
     tags-ignore:
       # Ignore continuous releases' tag.
       - 'continuous'
   pull_request:
+    types:
+        - opened
+        - reopened
+        - synchronize
 
 defaults:
   run:

.github/workflows/ci/workflow_template.yml

@@ -14,6 +14,10 @@
 /steno-notes-*.txt
 /strokes.log
 
+# Plover: build artifacts.
+news_draft.md
+notes.md
+
 # Pytest.
 /.pytest_cache/
 
@@ -26,4 +30,7 @@ __pycache__/
 # VSCode
 /.vscode/
 
+# macOS
+.DS_Store
+
 # vim: ft=cfg

.gitignore

@@ -0,0 +1,16 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
+python:
+  install:
+    - requirements: doc/requirements.txt
+
+sphinx:
+  configuration: doc/conf.py

.readthedocs.yml

@@ -1,9 +1,16 @@
-# Include: pretty much everything normally versioned,
-# and not already automatically included by setuptools.
 include CONTRIBUTING.md
 include LICENSE.txt
 include NEWS.md
-include doc/*
+recursive-include doc *.css
+recursive-include doc *.html
+recursive-include doc *.ico
+recursive-include doc *.md
+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/*
@@ -28,5 +35,4 @@ include test/*.py
 include test/gui_qt/*.py
 include tox.ini
 include windows/*
-
 exclude plover/gui_qt/*_ui.py

MANIFEST.in

@@ -1,3 +1,77 @@
+# v4.0.0rc2 (2023-09-28)
+
+
+
+## Features
+
+### Core
+
+- Added a configurable delay between key presses, to accommodate applications that can't handle fast keyboard emulation. (#1633)
+
+## Bugfixes
+
+### Core
+
+- Closes serial ports upon disconnection to ensure clean reconnections. (#1636)
+
+### User Interface
+
+- Update the tray icon to "disconnected" when a serial-over-USB machine is unplugged. (#1560)
+
+## API
+
+### Breaking Changes
+
+- Dropped support for Python 3.7. (#1634)
+
+### New
+
+- Introduces the `GenericKeyboardEmulation` interface which automatically handles output delay. (#1633)
+
+
+# v4.0.0rc1 (2023-09-26)
+
+
+
+## Features
+
+### Core
+
+- updated config to use tox4 (#1592)
+- Implement first-up chord send for keyboard machine. (#1611)
+
+### User Interface
+
+- Added Traditional Chinese (zh-TW) translation. (#1404)
+
+### Linux
+
+- Update GitHub Actions from Ubuntu 18.04 to 22.04. (#1597)
+
+### macOS
+
+- Update GitHub Actions from macOS 10.15 to 12. (#1598)
+- Changes the Plover icon on macOS to match Big Sur-style icons. (#1632)
+
+### Windows
+
+- Update GitHub Actions from Windows 2019 to 2022. (#1598)
+
+## Bugfixes
+
+### User Interface
+
+- Fix "add translation" dialog ignoring the stylesheet's background color for the translation and stroke text. (#1571)
+
+### Windows
+
+- Fixed an issue which caused tests to fail on windows due to case sensitive filepaths. (#1599)
+
+## API
+
+No significant changes.
+
+
 # v4.0.0.dev12 (2022-08-09)
 
 ## Features