plover 5.1.0__tar.gz → 5.2.0__tar.gz

{plover-5.1.0 → plover-5.2.0}/MANIFEST.in

@@ -5,6 +5,7 @@ recursive-include doc *.css
 recursive-include doc *.html
 recursive-include doc *.ico
 recursive-include doc *.md
+recursive-include doc *.rst
 recursive-include doc *.png
 recursive-include doc *.svg
 recursive-include doc *.py
@@ -33,10 +34,10 @@ include test/*.py
 include test/gui_qt/*.py
 include tox.ini
 include windows/*
-exclude dev/*
 exclude .pre-commit-config.yaml
 # 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 .mailmap

{plover-5.1.0 → plover-5.2.0}/NEWS.md

@@ -1,3 +1,44 @@
+# v5.2.0 (2026-02-01)
+
+
+## Features
+
+### Linux
+
+- Support determining keyboard layout from Wayland with the `wayland-auto` layout. (#1807)
+- Avoid unnecessary rapid modifier key press/release while typing. (#1810)
+
+### macOS
+
+- Add appearance configuration option. (#1786)
+
+### Windows
+
+- Add appearance configuration option. (#1786)
+
+## Bugfixes
+
+### Core
+
+- Fix a corner case in `plover -s (script)`. (#1803)
+
+### User Interface
+
+- Fix default window sizes and extensions config table. (#1789)
+- Update Thea's name and email. (#1792)
+- Remove broken use_timeout checkbox in serial options. (#1793)
+- Make the plugin manager handle some exceptional cases. (#1802)
+
+### macOS
+
+- Hide the Start Minimized setting on macOS due to bug in macOS 26. (#1788)
+
+## API
+
+### Core
+
+- Migrate HID library to cython-hidapi. (#1812)
+
 # v5.1.0 (2025-11-04)
 
 

{plover-5.1.0/plover.egg-info → plover-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plover
-Version: 5.1.0
+Version: 5.2.0
 Summary: Open Source Stenography Software
 Home-page: http://www.openstenoproject.org/
 Download-URL: http://www.openstenoproject.org/plover
@@ -35,7 +35,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: appdirs
 Requires-Dist: appnope; "darwin" in sys_platform
-Requires-Dist: hid
+Requires-Dist: hidapi
 Requires-Dist: pkginfo
 Requires-Dist: plover-stroke
 Requires-Dist: plyer; "win32" in sys_platform
@@ -48,6 +48,7 @@ Requires-Dist: python-xlib; "linux" in sys_platform or "bsd" in sys_platform
 Requires-Dist: evdev; "linux" in sys_platform or "bsd" in sys_platform
 Requires-Dist: packaging
 Requires-Dist: psutil; "linux" in sys_platform or "bsd" in sys_platform
+Requires-Dist: xkbcommon<1.1; "linux" in sys_platform or "bsd" in sys_platform
 Requires-Dist: readme-renderer[md]
 Requires-Dist: requests-cache
 Requires-Dist: requests-futures
@@ -165,7 +166,7 @@ including [StenoJig][] (JavaScript) and [StenoTray][] (Java).
 -   The [Plover Wiki][Wiki] discusses Plover and Open Steno in
     general. Edits to the Wiki and new page ideas are welcome.
 -   Graphic art for Plover and stenography in general is always
-    appreciated. The app's icons are worked on at [TheaMorin/plover\_icons][].
+    appreciated. The app's icons are worked on at [panathea/plover\_icons][].
     You may consider reimagining or reposing [Plover's mascot, Dolores][Mascot].
 -   UX improvement suggestions are welcome. Plover runs on Windows, Mac,
     and Linux, and should be powerful but out of the way, which poses
@@ -204,7 +205,7 @@ Please follow through for your system:
 [Troubleshooting Common Issues]: https://plover.wiki/index.php/Troubleshooting_issues
 [Wiki]: https://plover.wiki
 [installation guide]: https://plover.wiki/index.php/Installation_Guide
-[TheaMorin/plover\_icons]: https://github.com/TheaMorin/plover_icons
+[panathea/plover\_icons]: https://github.com/panathea/plover_icons
 [Windows README]: https://github.com/openstenoproject/plover/blob/main/windows/README.md
 [Linux README]: https://github.com/openstenoproject/plover/blob/main/linux/README.md
 [macOS README]: https://github.com/openstenoproject/plover/blob/main/osx/README.md

{plover-5.1.0 → plover-5.2.0}/README.md

@@ -98,7 +98,7 @@ including [StenoJig][] (JavaScript) and [StenoTray][] (Java).
 -   The [Plover Wiki][Wiki] discusses Plover and Open Steno in
     general. Edits to the Wiki and new page ideas are welcome.
 -   Graphic art for Plover and stenography in general is always
-    appreciated. The app's icons are worked on at [TheaMorin/plover\_icons][].
+    appreciated. The app's icons are worked on at [panathea/plover\_icons][].
     You may consider reimagining or reposing [Plover's mascot, Dolores][Mascot].
 -   UX improvement suggestions are welcome. Plover runs on Windows, Mac,
     and Linux, and should be powerful but out of the way, which poses
@@ -137,7 +137,7 @@ Please follow through for your system:
 [Troubleshooting Common Issues]: https://plover.wiki/index.php/Troubleshooting_issues
 [Wiki]: https://plover.wiki
 [installation guide]: https://plover.wiki/index.php/Installation_Guide
-[TheaMorin/plover\_icons]: https://github.com/TheaMorin/plover_icons
+[panathea/plover\_icons]: https://github.com/panathea/plover_icons
 [Windows README]: https://github.com/openstenoproject/plover/blob/main/windows/README.md
 [Linux README]: https://github.com/openstenoproject/plover/blob/main/linux/README.md
 [macOS README]: https://github.com/openstenoproject/plover/blob/main/osx/README.md

plover-5.2.0/doc/api/config.rst

@@ -0,0 +1,188 @@
+``plover.config`` -- Configuration
+==================================
+
+.. automodule:: plover.config
+   :no-members:
+
+.. autoclass:: plover.config.Config
+   :members:
+   :member-order: bysource
+   :special-members: __getitem__, __setitem__
+
+.. autoexception:: plover.config.InvalidConfigOption
+
+.. autoclass:: plover.config.DictionaryConfig
+   :members:
+   :member-order: bysource
+
+.. _config-keys:
+
+Configuration Options
+---------------------
+
+Below is the list of all available configuration keys:
+
+Output
+~~~~~~
+
+.. describe:: space_placement
+
+   When writing translations, whether to add spaces before or after each
+   translation. Possible values are ``Before Output`` and ``After Output``.
+   By default, will add spaces *before* translations.
+
+.. describe:: start_attached
+
+   Whether to delete the space before the translation when the initial
+   stroke is translated. ``False`` by default.
+
+.. describe:: start_capitalized
+
+   Whether to capitalize the translation when the initial stroke is
+   translated. ``False`` by default.
+
+.. describe:: undo_levels
+
+   The maximum number of translations Plover is allowed to undo. 100 by default.
+
+   Each stroke that performs a translation is added onto an undo stack, and
+   undo strokes (such as ``*``) remove translations from this stack.
+   ``undo_levels`` defines the maximum number of translations in the stack.
+
+Logging
+~~~~~~~
+
+.. describe:: log_file_name
+
+   The path to the stroke log file, either absolute or expressed relative to
+   :data:`CONFIG_DIR<plover.oslayer.config.CONFIG_DIR>`. ``strokes.log`` by default.
+
+   This only sets the path for stroke logs; main Plover logs are always
+   written to ``plover.log``.
+
+.. describe:: enable_stroke_logging
+
+   Whether to log strokes. ``False`` by default.
+
+.. describe:: enable_translation_logging
+
+   Whether to log translations. ``False`` by default.
+
+Interface
+~~~~~~~~~
+
+.. describe:: start_minimized
+
+   Whether to hide the main window when Plover starts up. ``False`` by default.
+
+.. describe:: show_stroke_display
+
+   Whether to show the paper tape when Plover starts up. ``False`` by default.
+
+.. describe:: show_suggestions_display
+
+   Whether to show the suggestions window when Plover starts up. ``False`` by default.
+
+.. describe:: translation_frame_opacity
+
+   The opacity of the Add Translation tool, in percent. 100 by default.
+
+.. describe:: classic_dictionaries_display_order
+
+   The order the dictionaries are displayed in the main window.
+   ``True`` displays the highest priority dictionary at the bottom;
+   ``False`` displays it at the top. ``False`` by default.
+
+Plugins
+~~~~~~~
+
+.. describe:: enabled_extensions
+
+   The list of extensions that are enabled.
+
+Machine
+~~~~~~~
+
+.. describe:: auto_start
+
+   Whether to enable Plover output when it starts up. ``False`` by default.
+
+.. describe:: machine_type
+
+   The name of the currently active machine. ``Keyboard`` by default.
+
+.. describe:: machine_specific_options
+
+   A dictionary of configuration options specific to the current machine.
+   Consult your machine plugin's documentation to see the available properties.
+   For the default machine plugins, the following options are available:
+
+   .. describe:: arpeggiate
+
+      Whether to enable arpeggiate mode on the keyboard. ``False`` by default.
+
+   .. describe:: port
+
+      The serial port for serial connections. No default value.
+
+      The value will most likely be different between platforms; Windows uses COM
+      ports, e.g. ``COM3``, whereas Unix-like platforms use device paths, e.g.
+      ``/dev/cu.usbmodem14403`` or ``/dev/ttyACM0``.
+
+   .. describe:: baudrate
+
+      The baud rate for serial connections. 9600 by default.
+
+   .. describe:: bytesize
+
+      The number of bits in a byte for serial connections. 8 by default.
+
+   .. describe:: parity
+
+      The parity bit mode for serial connections, one of
+      ``N`` (none), ``O`` (odd), ``E`` (even), ``M`` (mark) or ``S`` (space).
+      ``N`` by default.
+
+   .. describe:: stopbits
+
+      The number of stop bits for serial connections. 1 by default.
+
+   .. describe:: timeout
+
+      The read timeout for serial connections in seconds. 2.0 (2 seconds) by default.
+
+   .. describe:: xonxoff
+
+      Whether to use XON/XOFF flow control for serial connections.
+      ``False`` by default.
+
+   .. describe:: rtscts
+
+      Whether to use RTS/CTS flow control for serial connections.
+      ``False`` by default.
+
+System
+~~~~~~
+
+.. describe:: system_name
+
+   The name of the current steno system. This is the same system that
+   :mod:`plover.system` refers to. ``English Stenotype`` by default.
+
+.. describe:: system_keymap
+
+   A :class:`Keymap<plover.machine.keymap.Keymap>` mapping between machine
+   keys and steno keys in the current steno system.
+
+   If the system defines a keymap in :data:`KEYMAPS<plover.system.KEYMAPS>`
+   for the current machine type, that will be the default value; otherwise,
+   the machine may define a
+   :attr:`KEYMAP_MACHINE_TYPE<plover.machine.base.StenotypeBase.KEYMAP_MACHINE_TYPE>`
+   that describes a similar machine to fall back on. If that is not available
+   either, the default value is an empty keymap.
+
+.. describe:: dictionaries
+
+   A list of :class:`DictionaryConfig` representing the list of dictionaries
+   Plover uses to translate strokes for the current steno system. The
+   dictionaries should be listed in order of decreasing priority.

plover-5.2.0/doc/api/engine.rst

@@ -0,0 +1,148 @@
+``plover.engine`` -- Steno engine
+====================================================================
+
+.. automodule:: plover.engine
+   :no-members:
+
+.. autoclass:: plover.engine.StenoEngine
+
+   .. automethod:: _in_engine_thread
+
+   .. automethod:: start
+
+   .. automethod:: quit
+
+   .. automethod:: restart
+
+   .. automethod:: run
+
+   .. automethod:: join
+
+   .. automethod:: load_config
+
+   .. automethod:: reset_machine
+
+   .. automethod:: _send_engine_command
+
+   .. automethod:: toggle_output
+
+   .. automethod:: set_output
+
+   .. automethod:: __getitem__
+
+   .. automethod:: __setitem__
+
+   .. automethod:: get_suggestions
+
+   .. automethod:: clear_translator_state
+
+   .. automethod:: hook_connect
+
+   .. automethod:: hook_disconnect
+
+   The following methods simply provide a way to access the underlying
+   :class:`StenoDictionaryCollection<plover.steno_dictionary.StenoDictionaryCollection>`.
+   See the documentation there for more complete information.
+
+   .. automethod:: lookup
+
+   .. automethod:: raw_lookup
+
+   .. automethod:: lookup_from_all
+
+   .. automethod:: raw_lookup_from_all
+
+   .. automethod:: reverse_lookup
+
+   .. automethod:: casereverse_lookup
+
+   .. automethod:: add_dictionary_filter
+
+   .. automethod:: remove_dictionary_filter
+
+   .. automethod:: add_translation
+
+.. autoclass:: plover.engine.StartingStrokeState
+
+.. autoclass:: plover.engine.MachineParams
+
+.. autoclass:: plover.engine.ErroredDictionary
+
+.. _engine-hooks:
+
+Engine Hooks
+------------
+
+Plover uses engine hooks to allow plugins to listen to engine events. By
+calling :meth:`engine.hook_connect<plover.engine.StenoEngine.hook_connect>` and passing the
+name of one of the hooks below and a function, you can write handlers that are
+called when Plover hooks get triggered.
+
+.. plover:hook:: stroked(stroke: plover.steno.Stroke)
+
+   The user just sent a stroke.
+
+.. plover:hook:: translated(old, new)
+
+.. plover:hook:: machine_state_changed(machine_type: str, machine_state: str)
+
+   Either the machine type was changed by the user, or the connection state
+   of the machine changed. ``machine_type`` is the name of the machine
+   (e.g. ``Gemini PR``), and ``machine_state`` is one of ``stopped``,
+   ``initializing``, ``connected`` or ``disconnected``.
+
+.. plover:hook:: output_changed(enabled: bool)
+
+   The user requested to either enable or disable steno output. ``enabled`` is
+   ``True`` if output is enabled, ``False`` otherwise.
+
+.. plover:hook:: config_changed(config: Dict[str, Any])
+
+   The configuration was changed, or it was loaded for the first time.
+   ``config`` is a dictionary containing *only* the changed fields. Call the
+   hook function with the :attr:`StenoEngine.config<plover.engine.StenoEngine.config>`
+   to initialize your plugin based on the full configuration.
+
+.. plover:hook:: dictionaries_loaded(dictionaries: plover.steno_dictionary.StenoDictionaryCollection)
+
+   The dictionaries were loaded, either when Plover starts up or the system
+   is changed or when the engine is reset.
+
+.. plover:hook:: send_string(s: str)
+
+   Plover just sent the string ``s`` over keyboard output.
+
+.. plover:hook:: send_backspaces(b: int)
+
+   Plover just sent backspaces over keyboard output. ``b`` is the number of
+   backspaces sent.
+
+.. plover:hook:: send_key_combination(c: str)
+
+   Plover just sent a keyboard combination over keyboard output. ``c`` is a
+   string representing the keyboard combination, for example ``Alt_L(Tab)``.
+
+.. plover:hook:: add_translation()
+
+   The Add Translation command was activated -- open the Add Translation tool.
+
+.. plover:hook:: focus()
+
+   The Show command was activated -- reopen Plover's main window and bring it
+   to the front.
+
+.. plover:hook:: configure()
+
+   The Configure command was activated -- open the configuration window.
+
+.. plover:hook:: lookup()
+
+   The Lookup command was activated -- open the Lookup tool.
+
+.. plover:hook:: suggestions()
+
+   The Suggestions command was activated -- open the Suggestions tool.
+
+.. plover:hook:: quit()
+
+   The Quit command was activated -- wrap up any pending tasks and quit Plover.

plover-5.2.0/doc/api/machine_keyboard_capture.rst

@@ -0,0 +1,20 @@
+``plover.machine.keyboard_capture`` -- Keyboard capture
+================================================================
+
+.. automodule:: plover.machine.keyboard_capture
+   :no-members:
+
+.. autoclass:: plover.machine.keyboard_capture.Capture
+
+   .. automethod:: start
+
+   .. automethod:: cancel
+
+   .. automethod:: suppress
+
+   The following methods are available to implementors to hook into the
+   keyboard capture system:
+
+   .. automethod:: key_down
+
+   .. automethod:: key_up

plover-5.2.0/doc/api/machine_keymap.rst

@@ -0,0 +1,7 @@
+``plover.machine.keymap`` -- Machine key bindings
+=================================================
+
+.. automodule:: plover.machine.keymap
+   :members:
+   :member-order: bysource
+   :special-members: __getitem__, __setitem__

{plover-5.1.0 → plover-5.2.0}/doc/conf.py

@@ -1,4 +1,7 @@
 # Configuration file for the Sphinx documentation builder.
+from pygments.lexer import RegexLexer, bygroups
+from pygments import token as t
+from sphinx.highlighting import lexers
 
 # -- Project information -----------------------------------------------------
 
@@ -6,7 +9,7 @@ project = "Plover"
 copyright = "Open Steno Project"
 author = copyright
 
-release = "5.1.0"
+release = "5.2.0"
 version = release
 
 # -- General configuration ---------------------------------------------------
@@ -14,6 +17,8 @@ version = release
 extensions = [
     "sphinx_plover",
     "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
     "sphinx.ext.todo",
 ]
 
@@ -69,10 +74,6 @@ html_theme_options = {
     "dark_logo": "dolores.svg",
 }
 
-from pygments.lexer import RegexLexer, bygroups
-from pygments import token as t
-from sphinx.highlighting import lexers
-
 
 class RTFLexer(RegexLexer):
     name = "rtf"

{plover-5.1.0 → plover-5.2.0}/doc/developer_guide.md

@@ -17,20 +17,20 @@ You also need [CMake](https://cmake.org) to build [hidapi](https://github.com/li
 
 A typical development setup looks like this, assuming that `python` has the correct version:
 
-### Linux/macOS (Bash):
+## Linux/macOS (Bash):
 
 ```bash
 cd path/to/plover
 python -m venv .venv
 source .venv/bin/activate 
-pip install -r reqs/dev.txt
+pip install -c reqs/constraints.txt -r reqs/dev.txt
 pre-commit install
 pre-commit run --all-files
 tox
 tox -e launch -- -l debug
 ```
 
-### Windows (PowerShell):
+## Windows (PowerShell):
 
 This assumes that you installed a Git version that includes Git Bash.
 
@@ -38,7 +38,7 @@ This assumes that you installed a Git version that includes Git Bash.
 cd path\to\plover
 python -m venv .venv
 .venv\Scripts\Activate.ps1
-pip install -r reqs\dev.txt
+pip install -c reqs\constraints.txt -r reqs\dev.txt
 pre-commit install
 pre-commit run --all-files
 & "C:\Program Files\Git\bin\bash.exe" -lc "tox"
@@ -47,6 +47,26 @@ pre-commit run --all-files
 
 Some features require a Bash shell, which is why on Windows you need to run commands through Git Bash or similar.
 
+## Read the Docs build (Docker)
+
+To reproduce the Read the Docs build locally, use the official RTD build image.
+The image defaults to a non-root user, so run as root to install packages.
+
+```bash
+docker run --rm -it --platform=linux/amd64 -u root -v "$PWD":/work -w /work readthedocs/build:ubuntu-24.04-2024.06.17 bash
+
+apt-get update
+apt-get install -y python3 python3-venv python3-dev build-essential
+python3 -m venv .venv-rtd
+. .venv-rtd/bin/activate
+python -m pip install --upgrade pip setuptools
+python -m pip install -c reqs/constraints.txt -r reqs/dist.txt
+python -m pip install -r doc/requirements.txt
+python -m sphinx -b html -W doc doc/_build/html
+```
+
+The HTML output is in `doc/_build/html/index.html`.
+
 ## Tox
 
 The command for using tox is: `tox {-e envlist} {-- arguments}`. Use `tox -a
@@ -84,7 +104,7 @@ any other virtual environment](https://virtualenv.pypa.io/en/latest/user_guide.h
 
 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 -e 'py3,py36,py37,py38,py39` will execute the testsuite for each version
+`tox -e 'py3,py310,py311,py312` will execute the testsuite for each version
 of Python we support.
 
 # Creating a binary distribution

plover-5.2.0/doc/requirements.txt

@@ -0,0 +1,4 @@
+sphinx-plover==0.3
+furo==2025.12.19
+myst-parser==5.0.0
+appdirs==1.4.4

{plover-5.1.0 → plover-5.2.0}/linux/README.md

@@ -5,8 +5,7 @@
 To be able to setup a complete development environment, you'll need to manually
 install some system libraries (including the development version of your
 distribution corresponding packages):
-- Treal support: `libusb` (1.0) and `libudev` are needed by
-  the [`hidapi` package](https://pypi.org/project/hidapi/).
 - log / notifications support: `libdbus` is needed.
+- Uinput support: `libxkbcommon` is needed by the [`xkbcommon` package](https://pypi.org/project/xkbcommon)
 
 For the rest of the steps, follow the [developer guide](../doc/developer_guide.md).

{plover-5.1.0 → plover-5.2.0}/linux/appimage/build.sh

@@ -2,7 +2,6 @@
 
 set -e
 
-. ./plover_build_utils/deps.sh
 . ./plover_build_utils/functions.sh
 
 topdir="$PWD"
@@ -197,33 +196,10 @@ run "$linuxdeploy" \
 # Install Plover and dependencies.
 bootstrap_dist "$wheel"
 
-# ------- Start: Build & bundle hidapi from source -------
-hidapi_src="$builddir/hidapi-src"
-hidapi_bld="$builddir/hidapi-build"
-
-. ./linux/build_hidapi.sh
-
-echo "Downloading and unpacking hidapi ${hidapi_version}…"
-fetch_hidapi "$hidapi_src" "$builddir"
-
-echo "Building hidapi…"
-cmake_build_linux "$hidapi_src" "$hidapi_bld" "Release"
-
-# Locate the produced .so
-hidapi_so="$(find "$hidapi_bld" -name 'libhidapi-hidraw.so*' -type f -print -quit)"
-if [ -z "$hidapi_so" ] || [ ! -f "$hidapi_so" ]; then
-  echo "Error: built libhidapi-hidraw.so not found." >&2
-  exit 3
-fi
-
-# Bundle into the AppDir's lib directory
-run cp -v "$hidapi_so" "$appdir/usr/lib/"
-base="$(basename "$hidapi_so")"
-# Add symlink for unversioned .so if needed
-if [ ! -e "$appdir/usr/lib/libhidapi-hidraw.so" ]; then
-  ln -s "$base" "$appdir/usr/lib/libhidapi-hidraw.so"
-fi
-# ------- End: Build & bundle hidapi from source -------
+# Reinstall hidapi with the hidraw backend; libusb reports usage/usage_page as 0,
+# which results in HID keyboards not being detected by Plover.
+run "$python" -m pip uninstall -y hidapi || true
+run_eval "HIDAPI_WITH_HIDRAW=1 HIDAPI_WITH_LIBUSB=0 $python -m pip install --no-binary :all: --no-cache-dir hidapi"
 
 # Trim the fat, second pass.
 run "$python" -m plover_build_utils.trim "$appdir" "$builddir/blacklist.txt"

{plover-5.1.0 → plover-5.2.0}/osx/app_resources/Info.plist

@@ -7,7 +7,7 @@
 	<key>CFBundleDisplayName</key>
 	<string>Plover</string>
 	<key>CFBundleExecutable</key>
-	<string>MacOS/Plover</string>
+	<string>Plover</string>
 	<key>CFBundleIconFile</key>
 	<string>plover.icns</string>
 	<key>CFBundleIdentifier</key>

{plover-5.1.0 → plover-5.2.0}/osx/dmg_resources/settings.py

@@ -3,6 +3,9 @@
 import plistlib
 import os.path
 
+# `defines` is injected by dmgbuild; default to empty for linters.
+defines = globals().get("defines", {})
+
 application = defines.get("app", "./dist/Plover.app")
 appname = os.path.basename(application)