Skip to main content

Tools for extracting, processing, and generating interactive fields for PDFs containing white box fields.

Project description

flyfield

Transform static white box PDF forms into interactive forms for fast automation.


Overview

flyfield automatically analyzes static PDF forms, creates fillable fields, marks field locations for verification, fills and extracts data, and seamlessly converts money values between PDF text and spreadsheet/database numeric formats.


Key Features

  • Generate interactive form fields and marked-up PDFs from PDF white box forms
  • Fill and export form data using CSV files
  • Seamlessly convert money values between PDF text and CSV number formats
  • Simple command-line interface for efficient workflows
  • Open source and flexible for diverse PDF automation needs

Installation

Install with pipx:

pipx install flyfield

Check version:

flyfield --version

Or install via pip:

pip install flyfield

Usage

Run commands on PDF files as needed:

flyfield --input-pdf myfile.pdf --markup

Options:

  • --markup Generate a PDF highlighting white boxes
  • --fields Add interactive form fields
  • --fill Fill form fields using data from a CSV file
  • --capture Export filled form data to CSV
  • --input-csv Load field data from a CSV instead of extracting
  • --debug Show detailed processing logs

Example workflow:

flyfield --input-pdf form.pdf --markup --fields  
flyfield --input-pdf form-fields.pdf --input-csv form.csv --fill form-fill.csv  
flyfield --input-pdf form-filled.pdf --capture  

For Developers

Clone and install development tools:

git clone https://github.com/flywire/flyfield.git  
cd flyfield  
pip install -e .[dev]  

Run tests:

tox  

Modules:

  • extract — box detection
  • layout — analyse, group and filter fields
  • markup_and_fields — generate fields and markings
  • io_utils — data I/O
  • utils — utility functions

For CLI help:

python -m flyfield.cli --help  

License

GNU GPL v3.0 or later. See LICENSE.


Contributing

Contributions welcome via issues and pull requests.


Acknowledgements

  • Powered by PyMuPDF.
  • Uses PyPDFForm.
  • Designed to simplify workflows involving white boxed PDF form fields.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flyfield-2025.9.17.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flyfield-2025.9.17-py3-none-any.whl (27.9 kB view details)

Uploaded Python 3

File details

Details for the file flyfield-2025.9.17.tar.gz.

File metadata

  • Download URL: flyfield-2025.9.17.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flyfield-2025.9.17.tar.gz
Algorithm Hash digest
SHA256 c482c4348a340eedfd0142247de952194c76364b5b18260b32e122361e0bc97e
MD5 b4ccabc07e4c02e018e1c0e8207d2049
BLAKE2b-256 c267b8ac4c5e19b9295c21ad5c053e25622db10be162fe946a41ff2c93076fb5

See more details on using hashes here.

Provenance

The following attestation bundles were made for flyfield-2025.9.17.tar.gz:

Publisher: Create Tag & Publish Package.yml on flywire/flyfield

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flyfield-2025.9.17-py3-none-any.whl.

File metadata

  • Download URL: flyfield-2025.9.17-py3-none-any.whl
  • Upload date:
  • Size: 27.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flyfield-2025.9.17-py3-none-any.whl
Algorithm Hash digest
SHA256 bf3d29659ee49d77c21935198abb2f7faf59837ea2341294049f2fd54a16d9d2
MD5 96c75b7a6c87835489a3e19ada915d5d
BLAKE2b-256 91a55f0db4319699b5a985e699e61dedb1418b344e79e2429ce10c4e89114b42

See more details on using hashes here.

Provenance

The following attestation bundles were made for flyfield-2025.9.17-py3-none-any.whl:

Publisher: Create Tag & Publish Package.yml on flywire/flyfield

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page