1. Introduction

Automated Test Schema Linter ATS-Linter.

1.1. Description

This project contains library and terminal cli command for linting test code and test description based on the desired template schema. ats-linter can be used as an separate terminal CLI or as a configuration for pre-commit.

This package is available at pypi and conda-forge . This ensures easy installation to your test development environment by pip or micromamba.

1.1.1. Environment Setup

It is recommended to use an isolated environment for development. This project uses micromamba for fast, reproducible environment management.

To set up the environment:

micromamba create -f .githooks.d/pre-commit_environment.yaml
micromamba activate ats-linter

All dependencies (including test and dev) are specified in .githooks.d/pre-commit_environment.yaml and pyproject.toml.

1.1.2. Installation

Install from PyPI:

pip install --upgrade ats-linter

Or install for development:

pip install -r requirements-dev.txt
pip install -e .

1.1.3. Testing & Linting

Run all tests and coverage with tox:

tox -e py312
# or for all configured Python versions
tox

Lint and style checks:

tox -e lint

Build documentation:

tox -e docs

Run integration tests (requires Docker):

tox -e integration-test

1.1.4. How To Start ats-linter

Check installation-guide.