Develop this package
Contents
Develop this package#
Setup#
You need a working python
environment (system, virtualenv
, pyenv
, etc) version 3.8 or superior.
Then install the dependencies and a development instance using:
make install
Format codebase#
make format
Run tests#
Testing of this package is done with pytest
and tox
.
Run all tests with:
make test
Run all tests but stop on the first error and open a pdb
session:
./bin/tox -e test -- -x --pdb
Run tests named TestUtilsDiscussions
:
./bin/tox -e test -- -k TestUtilsDiscussions
Documentation#
Build this documentation
make docs-build
Live version#
To have a live version – with auto-update – of this documentation, run the command:
make docs-live
And then point your browser at http://localhost:8000