Reference¶

Every public function, grouped by what it is for. Each entry links to its full signature and description. All are importable from pdfexorcist.

Extracting¶


`extract()`	Read a PDF or image with several engines, parse, vote and check
`vote()`	The vote alone, on one row per engine reading

Parsers¶


`parse_rows()`	The default parser: a label, then values in reading order
`parse_by_columns()`	Places each value in the nearest column by its x position
`group_words()`	Word boxes to lines of `(x, text)` cells
`KEY`	The default parser’s key: `["page", "row", "col"]`

Checks¶


`check()`	Name a check
`total_check()`	A total must equal, or bound, the sum of its parts
`validate()`	Run checks on a DataFrame and fill its `failed` column

Engines and pages¶


`register()`	Add an engine
`EXTRACTORS`	Every registered engine, by name
`pages_matching()`	Pages chosen by the text they contain
`parse_pages()`	`"1-3, 7, 10-"` to a list of page numbers
`fit_page_boxes()`	A copy of a PDF whose page boxes cover all their text