⚙️ Installation

We recommend installing the package using uv or pipx.

Using uv (recommended)

To package with uv run:

uv tool install whiteprints

If you don’t have uv installed, you can have a look at the uv installation guide.

Using pipx

You can also install the package with pipx by running.

pipx install whiteprints

You can install pipx following the installation guide

From PyPI

To install the package from PyPI run

pip install whiteprints

Do not forget that you should probably not install the package as root but as a user. Moreover you should also install the package in a dedicated virtual environment (which is exactly what uv and pipx are doing).

From source

To install with pip from GitHub run the command:

pip install git+ssh://git@github.com/whiteprints/whiteprints

The same recommendations made for PyPI installation apply.

For additional information on source installation see PyPA’s guide: installing Packages.