Workflow

Todo

add nice introductory text

Getting Started

Initial Setup

Todo

how do I start working on TIRA?

Running TIRA locally

Todo

How to run TIRA locally

Commands

Linting

black --check tira/ tests/
flake8 tira/ tests/
mypy tira/ tests/

To let black reformat a file, run:

black tira tests

Unit Tests

pytest

Code Coverage

coverage run -m pytest tests
coverage xml --omit=tests/**

Generating documentation

From within the python-client/sphynx directory run

sphinx-apidoc -o . ../tira && make html

Releasing a new version

Todo

How to release a new version