This project implements the Open Test sequence eXchange (OTX) Checker for the ASAM Quality Checker project.
To install the project, run:
pip install -r requirements.txt
This will install the needed dependencies to your local Python.
The checker can be used as a Python script:
python main.py --help
usage: QC OTX Checker [-h] (-d | -c CONFIG_PATH)
This is a collection of scripts for checking validity of Open Test sequence eXchange format (.otx) files.
options:
-h, --help show this help message and exit
-d, --default_config
-c CONFIG_PATH, --config_path CONFIG_PATH
-
No issues found
-
Issues found on file
To run the tests, you need to have installed the main dependencies mentioned at Installation.
Install Python tests and development dependencies:
pip install -r requirements-tests.txt
Execute tests:
python -m pytest -vv
They should output something similar to:
===================== test session starts =====================
platform linux -- Python 3.11.9, pytest-8.2.2, pluggy-1.5.0
You can check more options for pytest at its own documentation.
For contributing, you need to install the development requirements besides the test and installation requirements, for that run:
pip install -r requirements-dev.txt
You need to have pre-commit installed and install the hooks:
pre-commit install