# dtactions
dtactions is an OpenSource extension module for the speech recognition program Dragon.
It is meant to perform actions that are common to other packages like Dragonfly, Unimacro and Vocola.
This document describes how to install dtactions for end users and for developers.
## Status
Sucessfully upgraded to Python 3.
## Instructions for End Users
If you would like to install dtactions for use, but not as a developer, here are the instructions:
Install Python and Natlink and the packages you would like to use (Dragonfly, Caster, Unimacro, Vocola) as described in the Natlink repository README.
1. Install dtactions
It will also pull any prerequisites from the [Python Packaging Index](https://pypi.org/).
In a `cmd` or `powershell` window (possibly in elevated mode) run:
- `py -m pip install dtactions`
## Instructions for Developers
If you are working on dtactions the most convenient setup is an [editable install](https://peps.python.org/pep-0660/). Your local git repository can be anywhere convenient.
Uninstall the packages you wish to develop. i.e pip if you want to work on `dtactions`:
`py -m pip uninstall dtactions` and answer yes to all the questions about removing files from your python scripts folder.
Run `py -m pip install -e .[dev,test]` from the dtactions project root. You can skip `[dev,test]` after the first install.
### Unit testing
Run pytest to run the tests, written in a combinatin of [unittest](https://docs.python.org/3/library/unittest.html)
and [pytest](https://docs.pytest.org/). If adding a test, pytest seems to be a lot more convenient and powerful.
Most tests go in `tests`; tests that require a natlink install go in `natlink_test` as not every package dependent on natlink.
You can run `py -m pip install dtactions[test]` or `py -m pip install dtactions[natlink_test]` if you don't have the prequisites like pytest.
You can run pytest from project root folder to run the tests that don't depend on natlink being installed. For the natlink-dependent tests, run
`py -m pytest natlink_test`.
## Notes About Packaging for Developers
The package is specified in `pyproject.toml`.
Too build the package locally,
`python -m build`. If this fails because you don't have build installed, run `pip install -e .[dev]`.
To publish to [dtactions in the Python Packaging Index](https://pypi.org/project/dtactions/), increase the version number in `__init__.py` and [draft a new release](https://github.com/dictation-toolbox/dtactions/releases).
Raw data
{
"_id": null,
"home_page": null,
"name": "dtactions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Quintijn Hoogenboom <q.hoogenboom@antenna.nl>, LexiconCode <CasterVoice@protonmail.com>",
"keywords": "dragon, speech, dictation, dictation-toolbox, natlink",
"author": null,
"author_email": "Quintijn Hoogenboom <q.hoogenboom@antenna.nl>",
"download_url": "https://files.pythonhosted.org/packages/d1/17/df1f279500579f552cf5b7caffdc1a2eadb221b0c34f8dd6425ae167d346/dtactions-1.6.3.tar.gz",
"platform": null,
"description": "# dtactions\n\ndtactions is an OpenSource extension module for the speech recognition program Dragon.\nIt is meant to perform actions that are common to other packages like Dragonfly, Unimacro and Vocola.\n\nThis document describes how to install dtactions for end users and for developers.\n\n## Status\nSucessfully upgraded to Python 3.\n\n## Instructions for End Users\n\nIf you would like to install dtactions for use, but not as a developer, here are the instructions:\n\nInstall Python and Natlink and the packages you would like to use (Dragonfly, Caster, Unimacro, Vocola) as described in the Natlink repository README.\n \n\n1. Install dtactions\n \n It will also pull any prerequisites from the [Python Packaging Index](https://pypi.org/).\n\n In a `cmd` or `powershell` window (possibly in elevated mode) run:\n - `py -m pip install dtactions`\n \n\n## Instructions for Developers\n\nIf you are working on dtactions the most convenient setup is an [editable install](https://peps.python.org/pep-0660/). Your local git repository can be anywhere convenient. \n\nUninstall the packages you wish to develop. i.e pip if you want to work on `dtactions`:\n `py -m pip uninstall dtactions` and answer yes to all the questions about removing files from your python scripts folder.\n\nRun `py -m pip install -e .[dev,test]` from the dtactions project root. You can skip `[dev,test]` after the first install.\n\n\n### Unit testing\nRun pytest to run the tests, written in a combinatin of [unittest](https://docs.python.org/3/library/unittest.html) \nand [pytest](https://docs.pytest.org/). If adding a test, pytest seems to be a lot more convenient and powerful.\n\nMost tests go in `tests`; tests that require a natlink install go in `natlink_test` as not every package dependent on natlink. \n\nYou can run `py -m pip install dtactions[test]` or `py -m pip install dtactions[natlink_test]` if you don't have the prequisites like pytest. \n\nYou can run pytest from project root folder to run the tests that don't depend on natlink being installed. For the natlink-dependent tests, run \n`py -m pytest natlink_test`. \n\n## Notes About Packaging for Developers\n\nThe package is specified in `pyproject.toml`. \n\nToo build the package locally, \n\n`python -m build`. If this fails because you don't have build installed, run `pip install -e .[dev]`. \n\nTo publish to [dtactions in the Python Packaging Index](https://pypi.org/project/dtactions/), increase the version number in `__init__.py` and [draft a new release](https://github.com/dictation-toolbox/dtactions/releases).\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "dtactions __init__",
"version": "1.6.3",
"project_urls": {
"Home": "https://github.com/dictation-toolbox/dtactions",
"Readthedocs": "https://dtactions.readthedocs.io/en/latest/sendkeys.html"
},
"split_keywords": [
"dragon",
" speech",
" dictation",
" dictation-toolbox",
" natlink"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "70219ed6c334765fa2e88f8ea000c3ae9a16d5a53735a44fd62d496029b7c28e",
"md5": "79beb2cc91a8a98d85bf3fc8f2f5da9a",
"sha256": "7b8008a4a1d35ce65e5c4100f543ded6a37640fff37369708666e5ae3587af0f"
},
"downloads": -1,
"filename": "dtactions-1.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79beb2cc91a8a98d85bf3fc8f2f5da9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 191466,
"upload_time": "2024-08-22T14:40:35",
"upload_time_iso_8601": "2024-08-22T14:40:35.469467Z",
"url": "https://files.pythonhosted.org/packages/70/21/9ed6c334765fa2e88f8ea000c3ae9a16d5a53735a44fd62d496029b7c28e/dtactions-1.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d117df1f279500579f552cf5b7caffdc1a2eadb221b0c34f8dd6425ae167d346",
"md5": "162317bb9800aa307031c5628a5935ea",
"sha256": "62912558ad7e3def1f746aa21f0e35e90fd4da34171383a1773533b0549f5ff7"
},
"downloads": -1,
"filename": "dtactions-1.6.3.tar.gz",
"has_sig": false,
"md5_digest": "162317bb9800aa307031c5628a5935ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 178388,
"upload_time": "2024-08-22T14:40:36",
"upload_time_iso_8601": "2024-08-22T14:40:36.941586Z",
"url": "https://files.pythonhosted.org/packages/d1/17/df1f279500579f552cf5b7caffdc1a2eadb221b0c34f8dd6425ae167d346/dtactions-1.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 14:40:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dictation-toolbox",
"github_project": "dtactions",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dtactions"
}
JSON
