Skip to main content

WebSocket server plugin for Steno Dojo — broadcasts strokes to the Steno Dojo app

Project description

plover-steno-dojo

PyPI License: MIT

A Plover extension that runs a local WebSocket server and broadcasts real-time stroke and machine state events to the Steno Dojo app.

No external dependencies — uses only the Python standard library.

Install

Search for plover-steno-dojo in Plover's Plug-ins Manager (Tools → Plug-ins Manager), then click Install and restart Plover.

Or from a terminal using Plover's bundled Python:

# macOS
/Applications/Plover.app/Contents/Frameworks/Python.framework/Versions/3.13/bin/python3.13 \
  -m pip install plover-steno-dojo

Usage

  1. After installing, open Plover's Plug-ins Manager
  2. Find plover-steno-dojo, click Enable, then Apply
  3. Restart Plover
  4. The plugin starts automatically and listens on ws://localhost:8086/
  5. Open Steno Dojo — it will connect automatically

Message format

All messages are JSON objects broadcast to every connected client:

{"type": "stroked", "stroke": "TEFT"}
{"type": "machine_state_changed", "machine_type": "Gemini PR", "state": "connected"}

Development

git clone https://github.com/VincentCosta6/plover-steno-dojo
cd plover-steno-dojo
pip install -e .

Releasing

  1. Update version = X.Y.Z in setup.cfg
  2. Commit and push
  3. Create a GitHub Release tagged vX.Y.Z

The publish workflow verifies the tag matches setup.cfg before uploading to PyPI.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plover_steno_dojo-0.2.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plover_steno_dojo-0.2.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file plover_steno_dojo-0.2.0.tar.gz.

File metadata

  • Download URL: plover_steno_dojo-0.2.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for plover_steno_dojo-0.2.0.tar.gz
Algorithm Hash digest
SHA256 6f20a4b43223f32f2dc140b4bfcd0eb8c3369985a6b979ff1fed24b86ae5f855
MD5 0ec44578595013ea11270c1d1ee4b3d5
BLAKE2b-256 5929cdcf6243f128adf388f6247b87f66d1a637a988040ebe314a52e0e0b3443

See more details on using hashes here.

Provenance

The following attestation bundles were made for plover_steno_dojo-0.2.0.tar.gz:

Publisher: publish.yml on VincentCosta6/plover-steno-dojo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file plover_steno_dojo-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for plover_steno_dojo-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eea55b22c8d1a8c97bf5b414afddfa24390ce88030fb3d41aff1a41611133247
MD5 359ccaba9500148f5b2e2dde92050eb4
BLAKE2b-256 f5344ae7fed243d48cad6af2ecac83bbfced70d8779502898b7d36ab6599269e

See more details on using hashes here.

Provenance

The following attestation bundles were made for plover_steno_dojo-0.2.0-py3-none-any.whl:

Publisher: publish.yml on VincentCosta6/plover-steno-dojo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page