Skip to main content

A package containing the API for the PTHat by CNC Design Limited

Project description

PTHat

Pulse Train HAT Python API. This is a Python API to control the PTHAT from CNC Design Limited

Build

To build the project files:

python setup.py sdist bdist_wheel

TestPyPI

To upload the project the first time until a token is obtained. This will prompt for username and password.

twine upload --repository-url https://test.pypi.org/legacy/ dist/*

To upload the project to TestPyPI:

twine upload -r testpypi dist/*

To install this package from TestPyPI:

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pthat

To view the project on TestPyPI: https://test.pypi.org/project/pthat/

Token

Token to upload this project to TestPyPI:

Username: __token__
Password: pypi-AgENdGVzdC5weXBpLm9yZwIkZjRjOWE2NDctYTI4MC00N2M0LWI1NDEtZmJjNTcyZTVjOTI4AAI2eyJwZXJtaXNzaW9ucyI6IHsicHJvamVjdHMiOiBbInB0aGF0Il19LCAidmVyc2lvbiI6IDF9AAAGIEfC11_SYnhL6S5C2xfRD2-HcgZ-iM070-FNwoJPf1ls

Keyring

To install the tokens to a local keyring do the following. Each command will prompt for the password. Just copy and paste the token.

keyring set https://upload.pypi.org/legacy/ __token__
keyring set https://test.pypi.org/legacy/ __token__

Pypi

To upload the project the first time until a token is obtained. This will prompt for username and password.

twine upload dist/*

To upload the project to pypi:

twine upload -r pypi dist/*

To install this package from pypi:

pip install pthat

Version

When the version is changed, there are currently four places the version number must be changed

  • pthat.py - _version variable
  • setup.py - version parameter
  • CHANGELOG.md
  • docs/conf.py - version and release variables

TODO

  • Example for changing direction after n number of revolutions
  • Example of reading pulse count and printing number of revolutions
  • Async sending and reading the serial device
  • Complete response parsing method

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pthat, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size pthat-1.0.1-py3-none-any.whl (26.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pthat-1.0.1.tar.gz (27.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page