Running Tests

tox is used to run tests. It will run mypy for type checking, pylint for linting, pytest for testing, and black for code formatting.

$ tox          # All python versions
$ tox -e py36  # Python 3.6
$ tox -e py37  # Python 3.7

Code Formatting

This project uses black for code formatting.

$ black .  # format all python code

Building Documentation

Documentation is built using sphinx.

$ cd docs/
$ make man  # Build manpage


$ python3 sdist bdist_wheel
$ twine check dist/*
$ twine upload dist/*