Reference

Navigation for the command-line interface, the main Python entry points, and the internal formhtr.libs packages they build on.

CLI

• Command-line interface — All formhtr subcommands and options (generated from argparse).

Core API

• Core API — Logsheet OCR pipeline (extract_logsheet(), process_logsheet_to_xlsx(), helpers) and interactive ROI helpers (formhtr.roi_tools).

  • extract_logsheet / preprocessing draws on libs.processing, libs.services, and libs support modules.

  • select_rois / annotate_rois draw on libs.extract_ROI and libs.annotate_ROI.

Other API modules

• Other API modules — Export-only pipeline, alignment helpers, PDF sizing, and system dependency checks (formhtr.export_logsheet, formhtr.auto_align, formhtr.manual_align, formhtr.pdf_utils, formhtr.deps).

Library internals (formhtr.libs)

• libs.extract_ROI — Rectangle detection, ROI selection CLI bridge, selection UI (formhtr.libs.extract_ROI).

• libs.annotate_ROI — ROI labelling UI and helpers (formhtr.libs.annotate_ROI).

• libs.processing — Alignment, checkbox/barcode handling, content parsing, spatial indexing, spreadsheet output (formhtr.libs.processing).

• libs.services — Google / Amazon / Azure Vision adapters and orchestration (formhtr.libs.services).

• libs support modules — PDF rasterization, layout config, geometry types, statistics, debug visualisation (formhtr.libs top-level modules).

Reference pages

• Command-line interface
• Core API
• Other API modules
• libs.extract_ROI
• libs.annotate_ROI
• libs.processing
• libs.services
• libs support modules