swarmauri_parser_pypdftk 0.11.0.dev1

PDF AcroForm field parser for Swarmauri using PyPDFTK and the native pdftk toolchain.

Swarmauri Parser PyPDFTK

swarmauri_parser_pypdftk is the Swarmauri PDF form-field parser for extracting AcroForm data through PyPDFTK and the native pdftk toolchain. It converts structured PDF form fields into a single Swarmauri Document so downstream workflows can index, validate, or route filled forms.

Why Use Swarmauri Parser PyPDFTK

• Extract structured PDF field data instead of only free-form text.
• Normalize AcroForm output into a Swarmauri Document for ingestion, automation, and analysis pipelines.
• Keep form parsing aligned with the same Swarmauri parser interface used by other document components.
• Pair form-field extraction with other PDF parsers when both structured fields and page text matter.

FAQ

What does this parser extract?
PDF form fields returned by pypdftk.dump_data_fields, such as AcroForm names and values.

Does it parse ordinary PDF text?
No. This package is for structured PDF form fields. Use another parser for general page text.

Does it need a system binary?
Yes. It depends on the pdftk or pdftk-java executable being installed and available on PATH.

What happens when the PDF has no form fields?
The parser returns an empty list.

Features

• Extracts PDF AcroForm fields through PyPDFTK.
• Returns one Swarmauri Document with newline-delimited key: value content.
• Preserves the input source path in metadata.
• Useful for form ingestion, validation, compliance workflows, and automation.
• Supports Python 3.10, 3.11, 3.12, 3.13, and 3.14.

Installation

uv add swarmauri_parser_pypdftk

pip install swarmauri_parser_pypdftk

System requirement:

• Install pdftk or pdftk-java and make sure the executable is available on PATH.

Usage

from swarmauri_parser_pypdftk import PyPDFTKParser

parser = PyPDFTKParser()
documents = parser.parse("forms/enrollment.pdf")

for document in documents:
    print(document.metadata["source"])
    print(document.content)

Examples

Extract form fields from a filled PDF

from swarmauri_parser_pypdftk import PyPDFTKParser

parser = PyPDFTKParser()
docs = parser.parse("forms/application.pdf")

if docs:
    print(docs[0].content)

Example output:

GivenName: John
FamilyName: Doe
BirthDate: 1990-01-01

Detect forms without field data

from swarmauri_parser_pypdftk import PyPDFTKParser

parser = PyPDFTKParser()
docs = parser.parse("forms/plain.pdf")

if not docs:
    print("No PDF form fields were detected.")

Related Packages

• swarmauri_parser_pypdf2
• swarmauri_parser_fitzpdf
• swarmauri_ocr_pytesseract
• swarmauri_parser_pypdftk

Swarmauri Foundations

• swarmauri
• swarmauri_core
• swarmauri_base
• swarmauri_standard

More Documentation

• PyPDFTK on PyPI
• pdftk-java project

Best Practices

• Use this parser for PDFs with real AcroForm fields, not for generic PDF page text.
• Validate that the pdftk binary is installed in deployment targets before running pipelines that depend on this package.
• Pair this package with swarmauri_parser_pypdf2 or swarmauri_parser_fitzpdf if you also need free-form page text.
• Route scan-only documents through OCR if they are image-based and contain no useful form structure.

License

This project is licensed under the Apache-2.0 License.