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.3.0.tar.gz (5.7 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.3.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: plover_steno_dojo-0.3.0.tar.gz
  • Upload date:
  • Size: 5.7 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.3.0.tar.gz
Algorithm Hash digest
SHA256 ba2627fac787eda0c3ffcb0424aeaea1a52bfe4b09b71b5ed24b7ce500265de9
MD5 6592022bbf8e90c99aa31fe8723714aa
BLAKE2b-256 4641b8ff85c5291ba99f4e1fe7ff73bcffe2e4c3f5f1c6e84bf3d80a348b5c2e

See more details on using hashes here.

Provenance

The following attestation bundles were made for plover_steno_dojo-0.3.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.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for plover_steno_dojo-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 84a3b5e5449f3d5e3b539efc2998f263ace9e9a23f784e9f642cdb530e9fe447
MD5 edfd26995fef7e524852b92b53f6fe11
BLAKE2b-256 f63a6afb704d171a33df040f86f3d91caa094e5363741d0aec01c1d05ed593fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for plover_steno_dojo-0.3.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