Internal

The following commands are used by the development team.

Updating package in PyPI

We have installed the package in the Python Package Index (pypi) at pyphetools. To update the version, first make sure the build and twine packages are installed (if necessary).

python3 -m pip install --upgrade build
python3 -m pip install --upgrade twine

To update the version in PyPI, update the version number in the pyproject.toml file, and execute the following commands to build and install.

updating package in PyPI

python3 -m build
python3 -m twine upload dist/*

Unit testing

Unit tests were written for pytest, which can be installed with pip and run from the top-level directory as

pytest

Documentation

These pages are generated with mkdocs.

To set things up, perform the following steps (substitute name of venv if needed).

python3 -m venv venvhpoo
source venvhpo/bin/activate
pip install --upgrade pip
pip install mkdocs
pip install mkdocs-material
pip install mkdocs-material[imaging]
pip install pillow cairosvg
pip install mkdocs-material-extensions
pip install mkdocstrings[python]

To start a local server, enter:

mkdocs serve