https://github.com/user202729/plover-startup-py

Quick and dirty plugin to run something when Plover starts.
https://github.com/user202729/plover-startup-py

plover plover-plugins

Last synced: about 12 hours ago
JSON representation

Quick and dirty plugin to run something when Plover starts.

• Host: GitHub
• URL: https://github.com/user202729/plover-startup-py
• Owner: user202729
• License: gpl-3.0
• Created: 2021-10-23T11:45:41.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-16T10:59:04.000Z (over 2 years ago)
• Last Synced: 2024-09-18T17:46:00.425Z (9 days ago)
• Topics: plover, plover-plugins
• Language: Python
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# plover-startup-py

Quick and dirty plugin to run something when Plover starts.

### About plugin

This plugin should only used for testing purposes. See also:

* [user202729/plover-debugging-console: A IPython debugging console for Plover.](https://github.com/user202729/plover-debugging-console)

* [user202729/plover-run-py: Command plugin for Plover to run an arbitrary Python command.](https://github.com/user202729/plover-run-py)

Disadvantages in comparison to writing an extension plugin:

* Can only be used on a single machine.

   However, it should not be hard to convert a configuration file into an extension plugin to be distributed.

Advantages over writing an extension plugin:

* For testing purposes, the user-provided code might have some bug/errors.

   While using a normal extension plugin might make Plover nonfunctional (for example if `stop()` raises

   an error, Plover quit will be interrupted), this module guarantees that Plover is never interrupted.

* Has a reload command, which is faster than restarting Plover.

* Some convenience functions to make hacks easier to achieve.

### Note

The code is executed when the extension plugin is started, so it might not be effective to patch some

commands that run before it (for example, functions to get keyboard devices etc.)

### Installation

The package can be installed from pip or GitHub.

### Configuration

You need to create a file named `plover_startup_py_config.py` in Plover's configuration folder

(see https://plover.readthedocs.io/en/latest/api/oslayer_config.html#plover.oslayer.config.CONFIG_DIR

for where it is exactly)

The file may define (and register) functions `start` and `stop`:

```python

@register_start

def start():

	pass

@register_stop

def stop():

	pass

```

They will be called when the plugin starts/stops (which is normally when Plover starts/exits)

The engine can be accessed as the global variable `engine`, and there are more convenience functions,

search for "convenience functions" in the source code for more details

(and to read their documentation).

The last line in `load_file()` function in `plover_startup_py/__init__.py` file

have the complete list of global variables passed to the configuration file.

### Usage

Go to "Plugins" tab of Plover configuration, enable the plugin named "plover_startup_py".

To view the full traceback/error messages, you may need to invoke Plover with `--log-level debug`.

There's also an additional command `{plover:plover_startup_py_reload}` for reloading the module.