This repository contains a small set of tools for developing TwinCAT projects.
Install it with pip from pypi.org with:
pip install twincat-tools
Use it as python -m tctools.[*].
Note: the PyPi package named TcTools is not affiliated with this project and is simply an unfortunate name conflict!
Install package in editable mode and get the development requirements with:
poetry install --with dev --with doc
The package uses dynamic versioning. The plugin can be added to your Poetry installation with:
poetry self add "poetry-dynamic-versioning[plugin]"
Documentation is built using Sphinx. This is done automatically and hosted by ReadTheDocs.
Code style is enforced with black, isort and flake8. Format code with:
isort .
black .
And verify code with: (flake8 extensions will also perform black and isort checks)
flake8 ./src ./tests
See RTD documentation for full overview of usage: https://twincat-tools.readthedocs.io/latest/pages/tools.html