Convert to plugin

This commit is contained in:
Stanley Sakai 2018-02-26 17:17:41 -05:00 • committed by Ted Morin
commit 52eece316b
3 changed files with 67 additions and 0 deletions

22
README.rst Normal file
View file

@ -0,0 +1,22 @@
Plover Stenograph USB
=====================
Purpose
-------
Implementation of Stenograph USB protocol for Diamanté and Luminex machines. Based on work by Ted Morin and Keith McCready.
Files
-----
* system.py - Contains key mappings and orthographic rules.
* stenograph.py - Thread-based monitoring of the Stenograph machine output.
* README.rst - Readme.
* setup.cfg - Python setup info.
Installation
------------
1. Make sure you have the Plover Plugin Manager (https://github.com/benoit-pierre/plover_plugins_manager) installed.
2. Pull down repo (click on "Clone or Download" and select "Download.")
3. Open terminal and navigate to the folder you unzipped the files to.
4. Run command `python3 -m pip install -e .` .
5. Make sure your Stenograph machine is plugged in and write a stroke to start a job.
6. Run Plover and select "Stenograph USB" from the dropdown list.

35
setup.cfg Normal file
View file

@ -0,0 +1,35 @@
[metadata]
name = plover_stenograph_usb
version = 0.0.1
description = Implementation of Stenograph USB protocol for Diamanté and Luminex machines. Based on work by Ted Morin and Keith McCready.
long_description = file: README.rst
author = Stanley Sakai
author_email = sakai.stanley@gmail.com
license = GNU General Public License v2 or later (GPLv2+)
url = https://github.com/stanographer/plover_stenograph_usb
classifiers =
Development Status :: 4 - Beta
Environment :: Plugins
Intended Audience :: End Users/Desktop
License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Operating System :: OS Independent
Programming Language :: Python :: 3
Programming Language :: Python :: 3.4
Programming Language :: Python :: 3.5
Programming Language :: Python :: 3.6
keywords = plover plover_plugin
[options]
zip_safe = True
tests_require =
mock
install_requires =
plover>=4.0.0.dev6
py_modules =
plover_stenograph_usb
[options.entry_points]
plover.machine =
Stenograph USB = plover_stenograph_usb:Stenograph
# vim: commentstring=#\ %s list

10
setup.py Normal file
View file

@ -0,0 +1,10 @@
#!/usr/bin/env python3
__requires__ = '''
setuptools>=34.4.0
'''
from setuptools import setup
setup()