Skip to content

Welcome to PyPDFForm⚓︎

PyPDFForm is a Python library for PDF form processing. It contains the essential functionalities needed to interact with PDF forms:

  • Inspect what data a PDF form needs to be filled with.
  • Fill a PDF form by simply creating a Python dictionary.
  • Create form fields on a PDF.

It also supports other common utilities such as extracting pages and merging multiple PDFs together.

Quickstart⚓︎

Here's a quick look at how PyPDFForm works:

pip install PyPDFForm

from PyPDFForm import BlankPage, PdfWrapper

pdf = PdfWrapper(BlankPage())

from PyPDFForm import Fields, RawElements

pdf.draw([
    RawElements.RawText("My Textfield:", 1, 100, 600),
    RawElements.RawText("My Checkbox:", 1, 100, 550),
])
pdf.bulk_create_fields([
    Fields.TextField("my_textfield", 1, 180, 596, height=16),
    Fields.CheckBoxField("my_checkbox", 1, 180, 546, size=16),
])

from pprint import pprint

pprint(pdf.schema)

pdf.widgets["my_textfield"].font_color = (1, 0, 0)
pdf.widgets["my_textfield"].alignment = 1

pdf.fill({
    "my_textfield": "this is a text field",
    "my_checkbox": True,
})

pdf.write("output.pdf")

What's next?⚓︎