PyCape Contribution Guide

This document outlines how to install and set up the pycape library for local development.

Style Guide

We use Black to avoid thinking about most code style choices. For all other style questions, we follow Google's styleguide for Python.

This section describes how to set up your local environment so you can develop and test pycape.

Clone the repo:

git clone https://github.com/capeprivacy/pycape.git

Next install the library and all of its dependencies:

make install

We use the pytest framework to run unittests in pycape.

To run the test suite invoke pytest with:

make test

To ensure your changes will pass our CI, it's wise to run the following commands before committing:

make ci-ready

# or, more verbosely:

make fmt
make lint
make test-ci