Zum Inhalt springen

Guide · Python

PDFs aus einer CSV erzeugen mit Python

Eine Liste von Personen und eine Vorlage ergeben einen Stapel Dokumente. Statt einer Anfrage je Zeile reiht ein Batch bis zu 1.000 Renderings als einen Job ein, und es kommt ein Zip zurück. Dieses Python-Programm liest eine CSV, bildet die Zeilen ab und wartet auf den Job.

Kostenloser Plan mit 100 Einheiten im Monat, keine Kreditkarte

Was Sie brauchen

  • Einen API-Key. Legen Sie ihn in der App unter API-Schlüssel an und exportieren Sie ihn als FORMFEED_API_KEY. Zum Ausprobieren ist ein Test-Key (ff_test_…) richtig. Siehe Quickstart.
  • Python. Sie brauchen Python 3.10 oder neuer und das Paket formfeed (es bringt httpx und pydantic mit).
  • Die Vorlage. certificate aus dem Zertifikats-Beispiel, deren Felder genau die Spalten der CSV sind.
  • Die CSV. attendees.csv neben dem Programm, mit Kopfzeile. Sie steht weiter unten.
  • Genug Einheiten. Batches gehören zu jedem Tarif, und jeder Eintrag zählt mindestens als eine Einheit. Im Free-Tarif wird ein Live-Batch abgelehnt, wenn im Monat weniger Einheiten übrig sind, als der Batch Einträge hat; ein Test-Schlüssel wird nicht gezählt. Die Limits-Seite nennt die Einheiten je Tarif.
InstallierenShell
pip install formfeed

Das Programm

Das Programm liest die CSV, macht aus jeder Zeile einen Eintrag, reiht sie mit zip: true als einen Job ein, wartet, bis der Job fertig ist, und speichert das Archiv.

batch.pyPython
import csv
import os
import urllib.request
from pathlib import Path

from formfeed import Formfeed

formfeed = Formfeed(api_key=os.environ["FORMFEED_API_KEY"])

with open("attendees.csv", newline="", encoding="utf-8") as file:
    attendees = list(csv.DictReader(file))

job = formfeed.renders.batch(
    # every field of a CSV is text: the template expects hours as a number
    [{"data": {**a, "hours": int(a["hours"])}} for a in attendees],
    template="certificate",
    zip=True,
)
print(job.id, job.total, "queued")

# polls GET /jobs/{id} until the job is done, with a timeout
done = formfeed.jobs.wait_for(job.id)
print(f"{done.succeeded}/{done.total} rendered, {done.failed} failed")

if done.zip_url:
    with urllib.request.urlopen(done.zip_url) as answer:
        Path("certificates.zip").write_bytes(answer.read())

Ausführen

Es gibt die Job-ID und die Zahl der eingereihten Renderings aus, dann 4/4 rendered, 0 failed, und certificates.zip liegt neben dem Programm, mit einem PDF je Zeile, 0001-document.pdf bis 0004-document.pdf.

Shell
export FORMFEED_API_KEY=ff_test_...
python batch.py

Was an Python besonders ist

  • Keyword-Argumente. Jedes Feld der Anfrage ist ein Keyword-Argument (renders.create, pdf.protect), nach den Einträgen von renders.batch und den Quellen von pdf.merge, die zuerst kommen; verschachtelte Optionen wie settings oder post sind einfache Dictionaries.
  • Retries sind eingebaut. Der Client sendet mit jedem Rendering einen Idempotency-Key und wiederholt 429, 503 und Netzwerkfehler bis zu dreimal mit Backoff, mit demselben Schlüssel: Ein Retry einer Anfrage, die schon beantwortet wurde, erhält diese Antwort zurück statt eines zweiten Renderings.
  • Typisierte Ergebnisse. Die Antwort ist ein pydantic-Modell: render.download_url, render.page_count und render.units sind Attribute, keine Dictionary-Schlüssel.
  • Auch asynchron. AsyncFormfeed hat dieselben Methoden als Coroutinen, für FastAPI oder jeden anderen asyncio-Dienst.

Die CSV

Eine Kopfzeile, eine Zeile je Dokument. Die Spalten sind die Felder, die die Vorlage erwartet, eine Zuordnungstabelle braucht es also nicht:

attendees.csvText
name,course,completed_on,hours
Erika Mustermann,Analytical Engines 101,2026-09-10,16
Max Mustermann,Analytical Engines 101,2026-09-10,16
Jane Doe,Print CSS for developers,2026-09-11,8
John Doe,Print CSS for developers,2026-09-11,8

Was ein Batch anders macht

  • Immer asynchron. Die Antwort kommt sofort mit dem Status queued. Die Renderings laufen im Hintergrund, so viele gleichzeitig, wie Ihr Tarif erlaubt.
  • Eine Vorlage, viele Einträge. Ein template auf oberster Ebene gilt für jeden Eintrag, der keine eigene nennt; ein Eintrag besteht deshalb meist nur aus seinen data.
  • Teilweise gescheitert ist ein Zustand. Ein Job, in dem einige Einträge gescheitert sind, endet als partially_failed (failed, wenn alle gescheitert sind). succeeded und failed zählen sie, und jeder Eintrag ist in items ein eigenes Rendering mit eigenem Fehler.
  • Das Zip ist optional. Jeder Eintrag behält in items seine eigene Download-URL, und das wollen Sie, wenn die Dokumente an verschiedene Personen gehen. zip: true legt die geglückten zusätzlich in ein Archiv, jedes benannt mit 0001- und dem filename seines Eintrags (document.pdf ohne einen), in der Reihenfolge der Zeilen.
  • Oder ein Webhook. Statt zu warten, geben Sie dem Batch eine webhook_url und lassen sich von job.completed benachrichtigen (oder von job.failed, wenn alle Einträge gescheitert sind). Für tausende Dokumente ist das die bessere Form: kein Prozess, der minutenlang wartet.

Wenn die API nein sagt

  • Eine Form für jeden Fehler. Fehler sind Problem-Dokumente (RFC 9457) mit type, title, status, detail, einem stabilen code und der request_id, die Sie dem Support nennen; die type-URL führt zu einer Seite über diesen Fehler. Die Liste steht in der Fehlerreferenz.
  • Die üblichen. 401 unauthorized bei fehlendem oder widerrufenem Schlüssel, 404 template_not_found bei falschem Vorlagennamen, 422 template_runtime_error, wenn die Vorlage an den Daten scheitert, 429 rate_limited über den Anfragen pro Sekunde des Tarifs, 402 quota_exceeded, wenn die Einheiten des Free-Tarifs verbraucht sind (ein bezahlter Tarif rechnet weitere Einheiten ab, bis zu seiner Obergrenze).
  • Sicher wiederholen. Senden Sie beim POST einen Idempotency-Key-Header und wiederholen Sie die Anfrage mit demselben Schlüssel, wenn Sie nicht wissen, ob der erste Versuch ankam: 24 Stunden lang liefert der Schlüssel die erste Antwort, statt erneut zu rendern und zu berechnen. Gespeichert wird die Antwort, sobald der erste Versuch beantwortet ist; wiederholen Sie also nicht, solange er noch laufen kann. Auch Probleme unter 500 werden gespeichert, eine korrigierte Anfrage braucht deshalb einen neuen Schlüssel.

Die Aufgabe um dieses Programm

Dieser Guide ist ein Programm. Was die Aufgabe darum herum braucht, von der Vorlage bis zu Limits und Preis, steht auf der Seite Zertifikate per API erzeugen.

Weitere Guides für Python

FAQ

Wie viele Zeilen darf ein Job haben?
Bis zu 1.000 Einträge je Batch. Teilen Sie eine längere Liste auf mehrere Jobs auf; wie viele Jobs Sie starten, ist nicht begrenzt, und jeder zählt einmal gegen das Rate Limit. Siehe Async und Batch.
Was passiert, wenn eine Zeile falsch ist?
Scheitert die Vorlage an den Daten einer Zeile, scheitert dieser Eintrag, und die anderen rendern trotzdem: Der Job endet als partially_failed, und der gescheiterte Eintrag trägt den Fehler; Sie können die Zeile korrigieren und einzeln erneut rendern. Ein Eintrag, den die API von vornherein ablehnt (ein Feld der Anfrage, das sie nicht annimmt, oder Daten, die mit validate_data nicht zum Schema der Vorlage passen), lässt den ganzen Batch scheitern, bevor etwas eingereiht wird, und das Problem nennt seine Position.
Kostet ein gescheiterter Eintrag Einheiten?
Nein. Gezählt wird nur, was entstanden ist.
Geht das auch ohne Code, mit einer Tabelle?
Ja: Die App nimmt eine CSV- oder Excel-Datei, ordnet die Spalten den Feldern der Vorlage zu und führt den Batch aus. Der Code hier ist dasselbe innerhalb Ihres eigenen Systems.

Batch aus einer CSV in anderen Sprachen

Heute mit dem Rendern beginnen

Der kostenlose Plan enthält 100 Einheiten im Monat und kostenlose Testrenderings. Wechseln Sie den Plan, wenn Sie mehr brauchen.