# 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 instlall 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/).
- `py -m pip install dtactions`
This will install the packages in your Python site-packages area. It will also add the following commands, which should be
in your path now in your commmand prompt:
## 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 .` from the dtactions project root.
### 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 test; 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` and uses [flit](https://pypi.org/project/flit/) as the underlying build tool.
Too build the package locally,
`py -m flit build` (or just `flit build`) builds the package. You can also use `python -m build` if you have build installed. A github action publishes to publishes to [Python Packaging Index](https://pypi.org/).
Version numbers of the packages must be increased before your publish to [Python Packaging Index](https://pypi.org/).
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/f0/7f/7338b58202b0841d0987ee8e2114f3e089199f442f986e65ea6ae2fe4b8f/dtactions-1.6.1.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 instlall 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 It will also pull any prerequisites from the [Python Packaging Index](https://pypi.org/).\n\n - `py -m pip install dtactions`\n\n This will install the packages in your Python site-packages area. It will also add the following commands, which should be\n in your path now in your commmand prompt:\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 .` from the dtactions project root. \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 test; 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` and uses [flit](https://pypi.org/project/flit/) as the underlying build tool. \n\nToo build the package locally, \n\n`py -m flit build` (or just `flit build`) builds the package. You can also use `python -m build` if you have build installed. A github action publishes to publishes to [Python Packaging Index](https://pypi.org/). \n\n\n \nVersion numbers of the packages must be increased before your publish to [Python Packaging Index](https://pypi.org/). \n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "dtactions __init__",
"version": "1.6.1",
"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": "08191732d0d4295f95e7d6b5718f4a2ec9403d092a609ba74777c49fbdb1f49d",
"md5": "0408580e30efad68e277e192a6bbb623",
"sha256": "d8bfa692c3137fecdb43706ad3a369d9c15ab37cbc4fd336fbde810f02c09e20"
},
"downloads": -1,
"filename": "dtactions-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0408580e30efad68e277e192a6bbb623",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 183190,
"upload_time": "2024-04-08T15:24:57",
"upload_time_iso_8601": "2024-04-08T15:24:57.881119Z",
"url": "https://files.pythonhosted.org/packages/08/19/1732d0d4295f95e7d6b5718f4a2ec9403d092a609ba74777c49fbdb1f49d/dtactions-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f07f7338b58202b0841d0987ee8e2114f3e089199f442f986e65ea6ae2fe4b8f",
"md5": "9149da5b55f32a7567080dbfce187ec9",
"sha256": "04c5c2bcfcd39bceab6486f6adb7d2a28f067ac97105718816bd67453a3ddee9"
},
"downloads": -1,
"filename": "dtactions-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "9149da5b55f32a7567080dbfce187ec9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 171438,
"upload_time": "2024-04-08T15:24:59",
"upload_time_iso_8601": "2024-04-08T15:24:59.737394Z",
"url": "https://files.pythonhosted.org/packages/f0/7f/7338b58202b0841d0987ee8e2114f3e089199f442f986e65ea6ae2fe4b8f/dtactions-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-08 15:24:59",
"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
