Erste Schritte

Installation

Holen Sie einen Testschlüssel, installieren Sie Brevier mit pip, Docker oder Skript für Linux, macOS und Windows und erzeugen Sie Ihr erstes PDF.

Auf dieser Seite

Community

Voraussetzungen

  • Python 3.10 oder neuer, für die Installation mit pip
  • oder Docker, wenn Sie kein Python auf dem Rechner wollen

Brevier druckt mit WeasyPrint. WeasyPrint braucht die Textbibliothek Pango. Die meisten Linux-Systeme und macOS mit Homebrew haben sie schon. Fehlt Pango, bricht Brevier mit einem Hinweis ab, was zu installieren ist.

Testschlüssel holen

Jede Erzeugung braucht einen Lizenzschlüssel, auch zum Testen. Holen Sie den Schlüssel vor der ersten Erzeugung.

  1. Fordern Sie auf der Preisseite einen kostenlosen Testschlüssel für 30 Tage an. Er kommt per E-Mail.
  2. Setzen Sie die Umgebungsvariable BREVIER_LICENCE_KEY:
Linux und macOS
export BREVIER_LICENCE_KEY="<ihr-lizenzschluessel>"
Windows PowerShell
$env:BREVIER_LICENCE_KEY = "<ihr-lizenzschluessel>"

Nach 30 Tagen brauchen Sie eine bezahlte Lizenz.

Mit pip installieren

pip install brevier

Mit Docker starten

docker pull brevier/brevier:latest

Mit einem Skript installieren

Die Installationsskripte richten denselben Befehl brevier ein wie pip.

Linux und macOS
curl -fsSL https://get.brevier.dev | bash
Windows PowerShell
irm https://get.brevier.dev/ps | iex

Erstes PDF erzeugen

Legen Sie document.html an:

document.html
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Getting started</title>
  <style>
    @page { size: A4; margin: 20mm; }
    body { font-family: sans-serif; font-size: 11pt; line-height: 1.5; color: #111; }
    h1 { font-size: 20pt; margin-bottom: 8mm; color: #0b3d91; }
    p { margin-bottom: 4mm; }
  </style>
</head>
<body>
  <h1>Hello, Brevier!</h1>
  <p>Rendered from the getting-started guide.</p>
</body>
</html>

Mit pip oder dem Skript erzeugen Sie aus document.html die Datei document.pdf:

brevier pdf document.html -o document.pdf

Mit Docker binden Sie den aktuellen Ordner als /work ein und geben BREVIER_LICENCE_KEY an den Container weiter:

docker run --rm -v "$(pwd):/work" -e BREVIER_LICENCE_KEY="$BREVIER_LICENCE_KEY" brevier/brevier:latest pdf document.html -o document.pdf

Auf Fedora, RHEL und anderen Systemen mit SELinux schreiben Sie "$(pwd):/work:Z" statt "$(pwd):/work". Ohne :Z kann der Container document.pdf nicht in den Ordner schreiben.

Öffnen Sie document.pdf. Die nächste Seite baut eine echte Rechnung.