Welcome to the flyfield Documentation

This documentation supports users and developers working with flyfield, a Python tool to automate white-box PDF form field extraction, filling, and data capture.

Tutorials

• Quick Start Guide
  Fast-track for new users to start extracting and filling forms.
• Worked Example
  Step-by-step walkthrough using a real-world tax form.

---

How-To Guides

• Installation Guide
  Setup instructions and troubleshooting.
• Usage and CLI Reference
  Detailed command-line options and workflows.
• FAQ
  Frequently asked questions and common troubleshooting.

---

Reference

• Configuration and Constants
  Customization and advanced settings.
• API Documentation
  Programmatic interface for developers.

---

Concepts and Explanations

• Introduction
  Overview and purpose of flyfield.
• Process Explanation
  Detailed breakdown of internal workings.
• Glossary
  Definitions of key terms used throughout the docs.

---

Notes

• The tool only supports vector PDFs with white boxes, not scanned rasterized PDFs.
• Refer to tutorials and how-to guides first before diving into reference or concepts for a smoother learning curve.

---

Start your journey by exploring the Quick Start Guide.