Python portion of Natlink, a compatibility module for Dragon Naturally Speaking
Project description
Natlinkcore
More Information
Please refer to the README file in the project repository https://github.com/dictation-toolbox/natlink for more information about natlink.
Installing from PyPi
You can install from The Python Package Index (PyPI) with
py -m pip install natlinkcore
Test Framework
Tests use the pytest 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 have build in support for test frameworks and make it easy to run and debug pytest. see Visual Studio Code for testing.
Building the Python Package Locally
The build happens through a powershell script. You don't have to know much powershell.
The powershell script runs the tests using pytest.
The package is built with Flit. The package will be produced in
dist/natlinkcore-x.y.z-py3-none-any.whl. To install it py -m pip install dist/natlinkcore-x.y.z-py3-none-any.whl
replacing x.y with the version numbers.
Normally if you are developing natlinkcore, you will with instead to install with py -m pip install -e .
, which will
let you make and test changes without reinstalling natlinkcore with pip. Note the flit install --symlink or --pth-file options are problematic so just use pip.
To start a powershell from the command prompt, type powershell
.
To build the package:
py -m flit build
from powershell or command prompt, which will run the the tests in natlinkcore/test, then build the the package.
To publish the package to The Python Package Index (PyPI)
publish_natlinkcore
from powershell.
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.
- don't publish if the tests are failing. The
publish_natlinkcore
will prevent this, please don't work around it.
Debugging Instructions
Read the detailed developer instructions for setting up the debugger. You can look in this projects tree until documentation/developers.rst.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for natlinkcore-5.3.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c580ff1aeca97ada6958b97b59c3928dab19f3d45f2b0dcf027b1be420d1bf1b |
|
MD5 | 6b54bd22a73cf1aa2036b2ccc5f7f29c |
|
BLAKE2b-256 | 971dc7e2627ddd94e5e3ae03a2f154a0359aaf04af0a3e54c96149628a32868c |