swarmauri_parser_pypdftk 0.8.3.dev18

A parser for extracting text from PDFs using PyPDFTK.

---

Swarmauri Parser PyPDFTK

Form-field parser for Swarmauri built on PyPDFTK. Extracts PDF AcroForm field metadata and returns it as Swarmauri Document content.

Features

• Calls pypdftk.dump_data_fields to extract field key/value pairs.
• Emits a single Document with newline-delimited key: value text and metadata['source'] set to the PDF path.
• Returns an empty list when no form fields exist or when parsing fails (logs the error).

Prerequisites

• Python 3.10 or newer.
• PyPDFTK plus the pdftk/pdftk-java binary available on the system path. Install operating-system packages: e.g., apt install pdftk-java or download pdftk for macOS/Windows.
• Read access to the PDF file path you provide.

Installation

# pip
pip install swarmauri_parser_pypdftk

# poetry
poetry add swarmauri_parser_pypdftk

# uv (pyproject-based projects)
uv add swarmauri_parser_pypdftk

Quickstart

from swarmauri_parser_pypdftk import PyPDFTKParser

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

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

Example output:

source: forms/enrollment.pdf
GivenName: John
FamilyName: Doe
BirthDate: 1990-01-01

Handling Missing Fields

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

if not docs:
    print("No form fields detected or parsing failed.")

Tips

• Ensure pdftk is installed and available on PATH; PyPDFTK delegates to the binary.
• For encrypted PDFs, remove or provide the password before parsing; pdftk cannot dump fields from password-protected documents without credentials.
• Combine with other Swarmauri parsers to extract both structured form data (PyPDFTKParser) and free-form text (PyPDF2Parser or FitzPdfParser).

Want to help?

If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing that will help you get started.