Development

This document is targeted at project developers. It helps people to make their first steps. It also serves as a general entry to development documentation like tooling configuration and usage.

Requirements

Your environment should fulfill the following basic requirements:

• Python. See pyproject.toml for the minimum required version.
• Poetry. Python packaging and dependency managed tool.
• Pre-commit. For managing and maintaining pre-commit Git hooks. Optional.
• Task. Task runner as simple alternative to Make. Optional.
• Unix-like. Not required by itself, but assumed as the standard.

In addition to the following sections in this document, note that the devel directory contains more documentation including further information about the tooling listed above.

Initial Setup

Python Environment

Ensure that Python Poetry is installed. After cloning this repo (probably your own fork) execute:

poetry install

Read devel/poetry.md for more info.

Pre-commit Hooks

Ensure that pre-commit is installed globally. Setup the pre-commit hooks:

pre-commit install --install-hooks
pre-commit install --install-hooks --hook-type commit-msg

Run all hooks to make sure things are alright:

pre-commit run -a

Read devel/pre-commit.md for more info.

Running Tests

Ensure that Task is installed. Run tests to make sure everything is setup correctly:

task test

Read devel/task.md for more info.