Getting started

Installation

Install the brevier command with pip or run it in Docker. Then check that it works.

On this page

Requirements

  • Python 3.10 or newer, for the pip install
  • or Docker, if you do not want Python on your machine

brevier prints with WeasyPrint. WeasyPrint needs the Pango text library. Most Linux systems and macOS with Homebrew have it already. If Pango is missing, brevier stops with a message that says what to install.

Install with pip

pip install brevier

Then check the version:

brevier --version

Run with Docker

docker pull brevier/brevier:latest
docker run --rm brevier/brevier --version

The image runs brevier in the folder /work. Mount your project there, and the paths in your command stay short:

docker run --rm -v "$PWD:/work" brevier/brevier render rechnung.html --data rechnung.json -o rechnung.pdf

Install with a script

The script installers set up the same brevier command.

Linux and macOS
curl -fsSL https://get.brevier.dev | sh
Windows PowerShell
iwr -useb https://get.brevier.dev/ps1 | iex

brevier is free for development, tests and CI. You pay only for production servers. See the pricing page.