# Plover Practice Plugin
This [Plover][] [plugin][] project contains examples of the following types of
plugins:
- [Command][] (e.g. `"{:COMMAND:OPEN_URL:https://www.openstenoproject.org/}"`)
- [Meta][] (e.g. `"{:RANDOM_NUMBER:1:100}"`)
- [Extension][] (e.g. `"{:GET_ENV_VAR:$USER}"`)
It is a companion repo to the following blog post:
- _[Creating Plover Plugins with Python][]_
This plugin is meant for educational purposes only, and hence deliberately not
entered into the [Plover Plugins Registry][], so it will not show up in Plover's
Plugins Manager (though it has be released to [PyPI][], where you can find it
[here][PyPI plover-practice-plugin]).
## Install
I recommend following the blog post to build out the plugin yourself, but if you
just want to test it out on your machine, you can install it using [Git][]:
```sh
git clone git@github.com:paulfioravanti/plover-practice-plugin.git
cd plover-practice-plugin
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.
### Enabling the Extension
- 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_practice_plugin` to activate
the plugin
[Command]: https://plover.readthedocs.io/en/latest/plugin-dev/commands.html
[Creating Plover Plugins with Python]: https://www.paulfioravanti.com/blog/creating-plover-plugins-python/
[Extension]: https://plover.readthedocs.io/en/latest/plugin-dev/extensions.html
[Git]: https://git-scm.com/
[Invoke Plover from the command line]: https://github.com/openstenoproject/plover/wiki/Invoke-Plover-from-the-command-line
[Meta]: https://plover.readthedocs.io/en/latest/plugin-dev/metas.html
[PyPI]: https://pypi.org/
[PyPI plover-practice-plugin]: https://pypi.org/project/plover-practice-plugin/
[Plover]: https://www.openstenoproject.org/
[Plover Plugins Registry]: https://github.com/openstenoproject/plover_plugins_registry
[plugin]: https://plover.readthedocs.io/en/latest/plugins.html#types-of-plugins
Raw data
{
"_id": null,
"home_page": "https://github.com/paulfioravanti/plover-practice-plugin",
"name": "plover-practice-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "plover plover_plugin",
"author": "Paul Fioravanti",
"author_email": "paul@paulfioravanti.com",
"download_url": "https://files.pythonhosted.org/packages/ae/46/f9229a50ef396596a307af1722dbf9fab486a1fc8a1442ba2599483ef915/plover_practice_plugin-0.0.1.tar.gz",
"platform": null,
"description": "# Plover Practice Plugin\n\nThis [Plover][] [plugin][] project contains examples of the following types of\nplugins:\n\n- [Command][] (e.g. `\"{:COMMAND:OPEN_URL:https://www.openstenoproject.org/}\"`)\n- [Meta][] (e.g. `\"{:RANDOM_NUMBER:1:100}\"`)\n- [Extension][] (e.g. `\"{:GET_ENV_VAR:$USER}\"`)\n\nIt is a companion repo to the following blog post:\n\n- _[Creating Plover Plugins with Python][]_\n\nThis plugin is meant for educational purposes only, and hence deliberately not\nentered into the [Plover Plugins Registry][], so it will not show up in Plover's\nPlugins Manager (though it has be released to [PyPI][], where you can find it\n[here][PyPI plover-practice-plugin]).\n\n## Install\n\nI recommend following the blog post to build out the plugin yourself, but if you\njust want to test it out on your machine, you can install it using [Git][]:\n\n```sh\ngit clone git@github.com:paulfioravanti/plover-practice-plugin.git\ncd plover-practice-plugin\nplover --script plover_plugins install --editable .\n```\n\n> Where `plover` in the command is a reference to your locally installed version\n> of Plover. See the [Invoke Plover from the command line][] page for details on\n> how to create that reference.\n\n### Enabling the Extension\n\n- After re-opening Plover, open the Configuration screen (either click the\n Configuration icon, or from the main Plover application menu, select\n `Preferences...`)\n- Open the Plugins tab\n- Check the box next to `plover_practice_plugin` to activate\n the plugin\n\n[Command]: https://plover.readthedocs.io/en/latest/plugin-dev/commands.html\n[Creating Plover Plugins with Python]: https://www.paulfioravanti.com/blog/creating-plover-plugins-python/\n[Extension]: https://plover.readthedocs.io/en/latest/plugin-dev/extensions.html\n[Git]: https://git-scm.com/\n[Invoke Plover from the command line]: https://github.com/openstenoproject/plover/wiki/Invoke-Plover-from-the-command-line\n[Meta]: https://plover.readthedocs.io/en/latest/plugin-dev/metas.html\n[PyPI]: https://pypi.org/\n[PyPI plover-practice-plugin]: https://pypi.org/project/plover-practice-plugin/\n[Plover]: https://www.openstenoproject.org/\n[Plover Plugins Registry]: https://github.com/openstenoproject/plover_plugins_registry\n[plugin]: https://plover.readthedocs.io/en/latest/plugins.html#types-of-plugins\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 or later (GPLv3+)",
"summary": "Plover practice plugin",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/paulfioravanti/plover-practice-plugin"
},
"split_keywords": [
"plover",
"plover_plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1c008ed852d84761e15f54fded6c956f3863aa001440e038d61db0b32fc853d",
"md5": "082630e95d114d2ab49fdbadcc03b4e8",
"sha256": "086b9e90837b72562680bff26406da213d0c41e4b103e867575ef2c10e88dff7"
},
"downloads": -1,
"filename": "plover_practice_plugin-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "082630e95d114d2ab49fdbadcc03b4e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16930,
"upload_time": "2024-02-04T02:26:43",
"upload_time_iso_8601": "2024-02-04T02:26:43.088130Z",
"url": "https://files.pythonhosted.org/packages/a1/c0/08ed852d84761e15f54fded6c956f3863aa001440e038d61db0b32fc853d/plover_practice_plugin-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ae46f9229a50ef396596a307af1722dbf9fab486a1fc8a1442ba2599483ef915",
"md5": "2e56942503ebdb9d82c272f7f760f0ee",
"sha256": "743fee0d63181f425ed87349f5c370712a4e56465afdce654502d04d82a2a4a1"
},
"downloads": -1,
"filename": "plover_practice_plugin-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2e56942503ebdb9d82c272f7f760f0ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15732,
"upload_time": "2024-02-04T02:26:44",
"upload_time_iso_8601": "2024-02-04T02:26:44.602138Z",
"url": "https://files.pythonhosted.org/packages/ae/46/f9229a50ef396596a307af1722dbf9fab486a1fc8a1442ba2599483ef915/plover_practice_plugin-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-04 02:26:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "paulfioravanti",
"github_project": "plover-practice-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "plover-practice-plugin"
}
JSON
