Legal Q&A (Question and Answer) formatting output for Plover.
Project description
Plover Q&A
This Plover extension plugin contains metas for your dictionaries that can assist with Q&A (Question and Answer): the process of recording lines of questioning in a conversation involving multiple people, usually in a legal context.
More information about the concept of Q&A can be found at:
More information about the creation of, and reasoning behind, the outlines that originally informed this plugin can be found at the following blog post:
You can see a video of the plugin in action here:
(And if you are a Vim user and want the syntax highlighting, you can find it in the Vim Steno Q&A plugin)
Install
- In the Plover application, open the Plugins Manager (either click the Plugins
Manager icon, or from the
Tools
menu, selectPlugins Manager
). - From the list of plugins, find
plover-q-and-a
- Click "Install/Update"
- When it finishes installing, restart Plover
- After re-opening Plover, open the Configuration screen (either click the
Configuration icon, or from the main Plover application menu, select
Preferences...
) - Open the Plugins tab
- Check the box next to
plover_q_and_a
to activate the plugin
Config and Dictionaries
See the examples
directory for example configuration and dictionaries to
help you get up and running with using this plugin for Q&A.
How To Use
See the INSTRUCTIONS
page.
Development
Clone from GitHub with git:
git clone git@github.com:paulfioravanti/plover-q-and-a.git
cd plover-q-and-a
python -m pip install --editable ".[test]"
If you are a Tmuxinator user, you may find my plover_q_and_a project file of reference.
Python Version
Plover's Python environment currently uses version 3.9 (see Plover's
workflow_context.yml
to confirm the current version).
So, in order to avoid unexpected issues, use your runtime version manager to make sure your local development environment also uses Python 3.9.x.
Testing
- Pytest is used for testing in this plugin.
- Coverage.py and pytest-cov are used for test coverage, and to run coverage within Pytest
- Pylint is used for code quality
- Mypy is used for static type checking
Currently, the only parts able to be tested are ones that do not rely directly on Plover.
Run tests, coverage, and linting with the following commands:
pytest --cov --cov-report=term-missing
pylint plover_q_and_a
mypy plover_q_and_a
To get a HTML test coverage report:
coverage run --module pytest
coverage html
open htmlcov/index.html
If you are a just
user, you may find the justfile
useful during
development in running multiple test commands. You can run the following command
from the project root directory:
just --working-directory . --justfile test/justfile
Deploying Changes
After making any code changes, install the plugin into Plover with the following command:
plover --script plover_plugins install --editable .
Where
plover
in the command is a reference to your locally installed version of Plover. See the Invoke Plover from the command line page for details on how to create that reference.
When necessary, the plugin can be uninstalled via the command line with the following command:
plover --script plover_plugins uninstall plover-q-and-a
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for plover_q_and_a-0.4.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a0c7e8ed429509c21cb24916d8d0a8c285fafe36e11ae4d56a53230e90a828c |
|
MD5 | 69dc72323f37272098f6e8f9a34c5e6d |
|
BLAKE2b-256 | ecb71f8512e660585c74a7b3ddf984a79eee0bcf5bfd963697b231239e980e3e |