CONTRIBUTING.md

Contributing

Getting started

Dependencies are managed with pipenv, a quick setup looks something like:

$ pipenv install --dev
# run everything from within a virtualenv
$ source "$(pipenv --venv)/bin/activate"
# alternatively, spawn a shell
$ pipenv shell

Linting

Linting is handled by pre-commit, install the git hook scripts and it should run successfully:

$ pre-commit install
$ pre-commit run --all-files

Testing

Unit Tests

Once things are installed these should run without requiring any more setup:

$ pytest

End-to-End test

These tests are found under tests/end_to_end and install some actual packages and runs py-unused-deps on them. Once the test dependencies are installed the tests should pass:

$ ./tests/end_to_end/data/install_all.py
$ pytest tests/end_to_end