How to Install Baseprinter

Baseprinter is tested on Linux, specifically Fedora 42, Ubuntu 24.04, and Debian Trixie. Mac and Windows users should run Baseprinter in a container. Linux users should also consider running Baseprinter in a container.

Installing Baseprinter locally on distributions other than Fedora, Ubuntu 24+, and Debian Trixie will likely require additional effort. If you are installing on another Linux distribution, it might be useful to see how the Baseprinter container images are built: baseprinter-base, baseprinter-core, and baseprinter.

Basic Installation

Installing pandoc is required, with a minimum version of 3.1.6.2.

Baseprinter is installed as a Python package:

pip install baseprinter

Warning

Depending on your environment and preferences, you might want to use the --user option, the --break-system-packages option, the sudo command, the venv module, running python3 -m pip, and/or similar alternatives to pip.

PDF Support

The basic installation only provides HTML previews, which give you an idea of how the generated PDF will appear. To enable PDF support, you need to install two additional packages:

1. WeasyPrint Installation.
2. The pdf extra from the baseprinter package:

pip install baseprinter[pdf]