Metadata-Version: 2.1
Name: natlinkcore
Version: 5.3.8
Summary: Python portion of Natlink, a compatibility module for Dragon Naturally Speaking
Author-email: "Quintijn Hoogenboom (maintainer)" <q.hoogenboom@antenna.nl>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: natlink>=5.3.4
Requires-Dist: pysimplegui>=4.60.3
Requires-Dist: pydebugstring
Requires-Dist: dtactions>=1.5.7
Requires-Dist: pyenvutils ; extra == "dev"
Requires-Dist: entry-point-inspector ; extra == "dev"
Requires-Dist: pytest >=7.1.2 ; extra == "test"
Project-URL: Home, https://github.com/dictation-toolbox/natlinkcore/
Provides-Extra: dev
Provides-Extra: test


# Natlinkcore 

## More Information
 Please refer to the README file in the project repository [https://github.com/dictation-toolbox/natlink](https://github.com/dictation-toolbox/natlink) for more information about natlink.

## Installing from PyPi
You can install from [The Python Package Index (PyPI)](https://pypi.org/) with 

`py -m pip install natlinkcore`

Note that natlinkcore will not install if you have not installed Natlink first.  Natlink is installed through running an installer.

 
## Test Framework
Tests use the [pytest](https://docs.pytest.org/) framework.  
For developers, if you are developing on the project, please add tests for any new features or bug
fixes.  

Mandy Python IDEs such as [Visual Studio Code](https://code.visualstudio.com/) have build in support for test frameworks and make it easy to run and debug pytest.   see [Visual Studio Code for testing](https://code.visualstudio.com/docs/python/testing).


## Building the Python Package Locally

`py -m build` to build the Python package locally.

Publishing to PyPi is done through the [trusted publisher mechanism](https://docs.pypi.org/trusted-publishers/using-a-publisher/) when a release is created on github using github actions. 


## Publishing checklist
Before you bump the version number in __init__.py and publish:
- Check the pyroject.toml file for package dependancies.  Do you need a specfic or newer version of
a dependancy such as dtactions?  Then add or update the version # requirement in dtactions.  

## Debugging Instructions

Read the detailed developer instructions for setting up the debugger.  You can look in this projects tree until 
documentation/developers.rst.


