Developer’s Guide

This document contains information on setting up a development environment.

Requirements

Altimeter requires Python 3.8 or greater.

To install project requirements, from the base repo dir:

find . -name requirements.txt -exec pip install -r {} \;

Pre-Commit Check

A pre-commit script is included (git/pre-commit.sh) which performs static analysis using mypy and pylint, code autoformat checking using black and runs tests all via tox.

This script is run as a part of Altimeter’s CI and must pass for contributions to be merged.

To configure this as a pre-commit hook, from the base repository directory:

ln -s ../../git/pre-commit.sh .git/hooks/pre-commit

This can be run by hand by running tox:

tox

Next Steps

See Extending Altimeter for a guide to extending Altimeter’s capabilities to collect and graph more data.