Skip to content

Commit

Permalink
release dtactions 1.6.2 (#19)
Browse files Browse the repository at this point in the history
* recommit, lots of thins

* try to get win32 function running... line 286

* simplified extenvvars, getFolderFromLibraryName, TODO later

* try to specify setClipboard function spurious error

* Vocola_compatibility moved from Unimacro to Dtactions repository

* Try to improve the README.md. The flit things still have to be removed.

* rename test directory to tests and rename alltests.py

* struggling with pytest config and updating new release number

* added python_files spec for locating tests

---------

Co-authored-by: Quintijn Hoogenboom <[email protected]>
  • Loading branch information
dougransom and quintijn authored Aug 9, 2024
1 parent 7b97926 commit 9ed4e30
Show file tree
Hide file tree
Showing 13 changed files with 706 additions and 12 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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.
This document describes how to install dtactions for end users and for developers.

## Status
Sucessfully upgraded to Python 3.
Expand All @@ -16,29 +16,28 @@ Install Python and Natlink and the packages you would like to use (Dragonfly, Ca


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:

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:
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.
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.
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.
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.

Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,11 @@ pythonpath = [
"src/dtactions",
]
testpaths= [
"unittest/",
"tests",
]
python_files = [
"unittest*.py",
"test_*.py",
]


2 changes: 1 addition & 1 deletion src/dtactions/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"""
## version to be updated when a new release is sent to pypi:
__version__ = '1.6.1' # new middle number with extenvvar.py and requirement of natlink, april 24
__version__ = '1.6.2'
##----------------------
import sys
import os
Expand Down
7 changes: 7 additions & 0 deletions src/dtactions/vocola_compatibility/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
2024//6/10: This directory was in the Unimacro repository, but is now put here, in dtactions.

The file "Unimacro.vch" holds the "USC-commands" ("Unimacro Shorthand Commands"), and the accompanying actions are also in this dtactions repository. So now, there remains no dependency between Vocola2 and Unimacro (as I am aware of).

For historic reasons though, the naming has been kept.

Quintijn Hoogenboom
Loading

0 comments on commit 9ed4e30

Please sign in to comment.