Instructions for contributors
Contribute to python-tuf by submitting pull requests against the “develop” branch of this repository. Detailed instructions are available in our development guidelines. All submitted code should follow our style guidelines and must be unit tested.
Also see development installation instructions.
With tox the whole test suite can be executed in
a separate virtual environment for each supported Python version available on
tuf and its dependencies are installed automatically for each
Below, you will see more details about each step managed by
tox, in case
you need debug/run outside
More specifically, the Update Framework’s test suite can be executed by invoking
the test aggregation script inside the tests subdirectory.
tuf and its
dependencies must already be installed.
$ cd tests/ $ python3 aggregate_tests.py
Individual tests can also be executed. Optional
-v flags can be added to
increase log level up to DEBUG (
$ cd tests/ $ python3 test_updater_ng.py -v
To run the tests and measure their code coverage, the aggregation script can be
invoked with the
coverage tool (requires installation of
$ cd tests/ $ coverage run aggregate_tests.py && coverage report
$ black <filename> $ isort <filename>