Instructions for developers¶

To contribute to this project, first fork it on GitHub and then clone your fork locally (replacing <username> with your GitHub username):

git clone https://github.com/<username>/PyABC2.git

Then set up a virtual environment and install dependencies. For example:

Linux/macOS

python -m venv venv
source venv/bin/activate

pip install flit
flit install --symlink

Windows

python -m venv venv
venv\Scripts\activate

pip install flit
flit install --pth-file

Then run tests to confirm that it works:

pytest -v -m "not slow"

Finally, there are several options for installing pre-commit. Once it is installed, install the pre-commit hooks for this project:

pre-commit install

You can now make a branch on your fork, work on the code, push your branch to GitHub, and make a PR to the parent repo.

Widget¶