Record, route, and review document extraction: one page at a time.
You OCR'd three thousand archive pages last spring. Which engine did page 341 go through, what did the run cost, which pages were too noisy to trust, and which ones still needed review? PageLedger is a run ledger for document extraction that keeps those answers on disk: you bring the engine (Tesseract, Docling, Marker, a cloud VLM), it applies configured or reviewed page routes, enforces page/token/dollar budgets, and writes the evidence as plain files you can grep, cite, and use to reconstruct the recorded methodology. No service, no database.
It grew out of a Soviet census digitization project, where "the model returned JSON" was the beginning of the work, not the end. It is built for people with the same problem: digital humanities labs, archives, historians, and anyone who has to defend their methodology months later.
pip install pageledgerOCR a scanned PDF. No config file needed; pdf_ocr uses your locally
installed Tesseract and poppler (pageledger doctor checks for both and
lists your installed OCR languages):
pageledger run scan.pdf --adapter pdf_ocr --out runs/first
pageledger inspect-run runs/firstruns/first/ now holds the extracted text plus the ledger: a manifest,
per-page provenance, quality warnings, aggregate word-level OCR confidence
evidence, cost evidence, and a review queue. Flagged pages are already listed
in an executable rerun plan, so escalating just those pages to a stronger
engine is one command, and comparing the two runs is another:
pageledger rerun runs/first --config stronger.yml --out runs/second
pageledger compare-runs runs/first runs/second
pageledger verify-run runs/secondOther first moves:
pageledger run report.pdf --adapter pdf_text --out runs/text # born-digital PDF (pip install "pageledger[pdf]")
pageledger run scan.pdf --adapter pdf_ocr --out runs/sample --pages "1-10" # sample before committing
pageledger run scan.pdf --config pageledger.yml --out runs/tuned --dry-run # inspect routing, spend nothing
pageledger run scan.pdf --config pageledger.yml --routes reviewed-routes.yml --out runs/routed
pageledger inspect-run runs/first --csv > pages.csv # triage in a spreadsheetNon-English documents: set lang and dpi in the config
(pageledger init-config --adapter pdf_ocr writes one with both knobs
visible). See docs/multilingual-ocr.md for a
worked Cyrillic example, including what the signals catch on an 1850 scan.
flowchart TD
A["inputs (text / PDF)"] --> B["paginate<br/>(form-feed or PDF pages)"]
B --> C["route pages<br/>route-map.yml"]
C --> D{"budget preflight<br/>max_pages"}
D -- over cap --> X["refuse: nothing written"]
D -- ok --> E["extract page via adapter<br/>(retry + backoff)"]
E --> F["quality signals<br/>quality.jsonl"]
E --> G["provenance.jsonl<br/>+ cost.json (cost_basis)"]
E --> H{"budget mid-run<br/>pages / tokens / USD"}
H -- over cap --> Y["halt: manifest status=failed,<br/>partial artifacts consistent"]
H -- ok --> E
F -- warnings --> I["review queue<br/>audit.json / audit.md"]
I --> J["rerun-manifest.yml"]
J -- "pageledger rerun<br/>(stronger adapter)" --> E
G --> K["pageledger compare-runs<br/>(parent vs rerun)"]
Every box on the right is a plain file in the run directory.
- Three built-in adapters (
text,pdf_text,pdf_ocr) and a thin protocol for wrapping anything else, from OCRmyPDF to a cloud VLM. - Quality signals per page: shape heuristics, Tesseract word confidence
with a
low_confidencewarning, and pre-1918 Russian orthography detection that flags a likely historical-model mismatch, plus conservative chat-template leakage and rerun-inflation warnings for model adapters. - Budgets denominated in pages, the one unit every backend shares, with tokens and dollars on top when they exist.
- Cost records that name their basis, so a derived estimate is never mistaken for provider-billed spend.
- Schema alignment: declare columns, aliases, types, and arithmetic checks
once, and structured extractor output (markdown tables, JSON, CSV)
becomes normalized records. Coercion failures and failed checks are
recorded, never silently fixed. Structural loss such as duplicate headers,
uneven rows, and ignored tables is recorded too.
pageledger aligncan preview or apply a revised schema without re-extracting (or re-paying). - Per-page grades (A–F) that combine text signals with schema evidence and
always name their basis.
A (signals)andA (schema)are different claims.review_below_grade: Cturns grades into a review queue. - Conditional page policies under
run.rerun_ifandrun.quarantine_ifact on grades, missing required columns, and arithmetic failure rates. Quarantined pages keep their audit evidence but stay out of rerun plans. - Reviewed route-map execution: feed per-page type/action/prompt decisions from
a human or external classifier back into
run --routes; PageLedger validates complete source coverage and preserves the routing evidence. - Optional continue-on-page-error behavior with a consecutive-failure circuit breaker. Failed and unattempted pages become auditable rerun work rather than disappearing behind the first exception.
- Page-scoped reruns with lineage, provenance-aware cross-run diffs, runtime ledger verification, CSV export, and environment diagnostics.
- JSON Schemas for JSON/JSONL artifacts, shipped in source and wheel
distributions, plus field-contract tests for YAML, enforced in CI, and an
AGENTS.mdso AI coding agents can operate the tool and validate their own output.
Without --routes, every page still uses one configured action. Automatic
classification and multi-adapter fallback chains remain design targets.
The full honest-scope list is in
docs/capabilities-and-limits.md.
Real documents, with walkthroughs: a 107-page declassified JFK-files scan
(free Tesseract pass, then a free local-LLM cleanup tier, then a paid
cloud VLM on the pages that needed it), a modern 259-page Russian report,
and an 1850 military-statistical review in pre-reform orthography that
the quality signals flagged page by page. Synthetic stress runs cover
5,000 pages at ~2,100 pages/sec. Details in
docs/capabilities-and-limits.md.
docs/README.md |
Documentation index |
docs/cli.md |
All eight commands, flags, and config keys |
docs/artifacts.md |
What each file in a run directory answers |
docs/capabilities-and-limits.md |
What works, what you supply, what is design |
docs/ocr-options.md |
Choosing local, cloud, or hybrid extraction |
docs/multilingual-ocr.md |
Non-English and historical documents |
docs/examples/jfk-scanned-archive.md |
Worked example: scan → flags → rerun → compare |
docs/adapter-protocol.md |
Wrapping your own OCR/VLM engine |
docs/design.md |
Why pages, design principles, and what comes next |
docs/comparison.md |
Positioning against the 2026 extraction ecosystem |
schemas/ |
JSON Schemas, the machine-readable artifact contract |
Testing a collection we haven't seen? Open a corpus report with the script, adapter, page count, and a redacted sample — real collections are how the quality signals improve. Development setup and guidelines are in CONTRIBUTING.md.
Software citation lives in CITATION.cff. PageLedger
keeps software and source-data citations separate; dataset_citation in
the config records the latter into every manifest.
MIT license.