Metadata-Version: 2.1
Name: twincat-tools
Version: 0.1.0
Summary: A set of tools for TwinCAT projects
Author-email: Robert Roos <robert.soor@gmail.com>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/DEMCON/twincat-tools
Project-URL: Bug Tracker, https://github.com/DEMCON/twincat-tools/issues
Project-URL: Documentation, https://twincat-tools.readthedocs.io
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: lxml~=4.9.3
Requires-Dist: EditorConfig~=0.12.3
Requires-Dist: GitPython~=3.1.36
Provides-Extra: test
Requires-Dist: black~=23.7.0; extra == "test"
Requires-Dist: pytest~=7.4.1; extra == "test"
Requires-Dist: pytest-cov~=4.1.0; extra == "test"
Requires-Dist: pytest-mock~=3.14.0; extra == "test"
Requires-Dist: flake8~=6.1.0; extra == "test"
Requires-Dist: flake8-bugbear~=23.7.10; extra == "test"
Provides-Extra: doc
Requires-Dist: sphinx~=7.3.7; extra == "doc"
Requires-Dist: sphinx_rtd_theme~=2.0.0; extra == "doc"
Requires-Dist: sphinx-argparse~=0.4.0; extra == "doc"

# TwinCAT Tools

[![Documentation](https://readthedocs.org/projects/twincat-tools/badge/?version=latest)](https://twincat-tools.readthedocs.io/latest/?badge=latest)
[![PyTest](https://github.com/DEMCON/twincat-tools/actions/workflows/tests.yml/badge.svg)](https://github.com/DEMCON/twincat-tools/actions)
[![codecov](https://codecov.io/gh/DEMCON/twincat-tools/graph/badge.svg?token=3NU2UNM2U0)](https://codecov.io/gh/DEMCON/twincat-tools)

This repository contains a small set of tools for developing TwinCAT projects.

## Install

Install it with pip from [pypi.org](https://pypi.org/project/twincat-tools/) 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!

## Develop

### Requirements

Install package in editable mode and get the development requirements with:
```
pip install -e .[test,doc]
```

### Documentation

Documentation is built using Sphinx.
This is done automatically and hosted by [ReadTheDocs](https://about.readthedocs.com/).

## Tools

See RTD documentation for full overview of usage: https://twincat-tools.readthedocs.io/latest/pages/tools.html
