DEVELOPMENT.md

Cross platform development

By installing make you can do the following:

$ make help
make install
 - Installs pdf_scrub.
make install-all
 - Install pdf_scrub, all development and tests dependencies.
make test
 - Runs integration tests and unit tests
make unit-test
 - Runs integration tests
make integration-tests
 - Runs unit tests
make lint
 - Lints your code (black, flake8 and mypy).
make fix
 - Autofixes imports and some formatting.

Developing on Linux

Run helping tools automatically on file change

While the make targets is an okay way to run things, I find it helpful to have my tests and linter running in separate terminal windows to get continous quick feedback.

The command ag is from The Silver Searcher program which can be found here. And the entr program can be found here.

Run unit tests on file change automatically

alias unit="ag -l | entr -c pytest --durations=0 tests/unit_tests"

Run flake8 on file change automatically

alias flakeit="ag -l | entr -c flake8 tests src"