Makefile is used to automate Pyroute2 deployment and test processes. Mostly, it is but a collection of common commands.
Clean up the repo directory from the built documentation, collected coverage data, compiled bytecode etc.
Build documentation. Requires Sphinx.
Build API documentation. Requires epydoc.
Pls notice that epydoc is discontinued. The reason to support it here is that it performs additional API testing and helps to highlight API inconsistencies.
No issues regarding epydoc output format are accepted.
Run tests against current code. Requires flake8, nosetests, coverage. Command line options:
Samples:
$ sudo make test python=python3 coverage=true wlevel=all
$ sudo make test wlevel=ignore module=test_ipdb:TestExplicit
Please notice, that by default tests run with wlevel=error, thus failing on any warning.
Buidl and install the package into the system. Command line options:
Other targets are either utility targets to be used internally, or hooks for related projects. You can safely ignore them.