fastdocparse 0.1.0__py3-none-any.whl

fastdocparse-0.1.0.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: fastdocparse
+Version: 0.1.0
+Summary: Extract structured data from semi-structured documents using any OpenAI-compatible LLM, with per-field grounding and confidence.
+License-Expression: MIT
+Requires-Python: <3.13,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: openai>=1.0
+Requires-Dist: pymupdf>=1.24
+Requires-Dist: pillow>=10.0
+Requires-Dist: rapidocr-onnxruntime>=1.3
+Requires-Dist: typer>=0.12
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Dynamic: license-file
+
+# docextract
+
+Extract structured data from semi-structured documents — invoices, bills, tax forms, resumes, bank statements, shipment manifests — using any OpenAI-compatible LLM (OpenAI, Ollama, vLLM, Groq, etc.), with **per-field grounding and confidence**, not just raw extraction.
+
+## Why this, not just another parser
+
+Most extractors give you a value and no way to know if it's real. This one tells you:
+
+- **`grounded`** — the value was found verbatim (or near-verbatim) in the source document text.
+- **`ungrounded`** — the value doesn't appear in the source — likely a hallucination. Flag for human review.
+- **`missing_required`** — a field you marked required came back empty.
+- **`invalid_format`** — the value doesn't match a pattern/enum constraint you declared (e.g. a shipment status outside the allowed list).
+- **`failed_check`** — a custom cross-field rule failed (e.g. line items don't sum to the stated total).
+
+No extra LLM call for any of this — it's deterministic, string/rule-based validation against text you already extracted.
+
+**Where it fits:** semi-structured documents with recurring fields (invoices, bills, tax forms, resumes, statements), and prose documents where *proving* a value came from the source matters (contracts, legal clauses, insurance claims). It is not a vision-LLM pipeline — it works from extracted text (digital PDF text layer, or local OCR for scans/images), which is what keeps it fast, cheap, and usable with small local models. Messy handwritten forms or complex multi-column layouts are a known weaker spot (see [document-extractor-spec.md](document-extractor-spec.md)).
+
+## Two ways to use it
+
+| | Who it's for | How |
+|---|---|---|
+| **CLI** | No coding needed | `docextract extract <file> <schema.json>` |
+| **Python API** | Building it into your own app | `DocumentParser(client).extract(document_bytes, schema)` |
+
+Defining *what* to extract also has two paths — hand-write a JSON/YAML schema file, or describe it in plain English and let the LLM draft the schema for you.
+
+## Install
+
+```bash
+git clone <this repo>
+cd document-extractor
+python -m venv venv
+source venv/bin/activate        # Windows: venv\Scripts\activate
+pip install -e .
+```
+
+(Not yet published to PyPI — see [Status](#status). Until then, install from a local clone as above.)
+
+You also need access to an LLM. Either:
+- An OpenAI API key (`export OPENAI_API_KEY=...` or pass `--api-key`), or
+- A local model via [Ollama](https://ollama.com/) — no API key, no cloud, documents never leave your machine.
+
+## Quickstart — CLI (no coding)
+
+```bash
+# 1. Extract using one of the bundled example schemas
+docextract extract sample_invoice.png src/docextract/schemas/invoice.json \
+  --model gpt-4o-mini --api-key sk-...
+
+# Or with a local model via Ollama (no API key needed):
+docextract extract sample_invoice.png src/docextract/schemas/invoice.json \
+  --model llama3.2 --base-url http://localhost:11434/v1 --api-key ollama
+```
+
+Output is JSON, printed to stdout (or saved with `--output result.json`):
+
+```json
+{
+  "_meta": { "truncated": false, "truncation_reason": null },
+  "invoice_number": { "value": "INV-9011", "confidence": "high", "flags": ["grounded"] },
+  "total_price": { "value": 100.0, "confidence": "high", "flags": ["grounded"] }
+}
+```
+
+Don't want to write JSON at all? Describe the fields in plain English instead:
+
+```bash
+docextract schema-from-text \
+  "I want the invoice number, total price, and vendor name. Invoice number and total are required." \
+  --output my_invoice_schema.json
+
+# review my_invoice_schema.json, then:
+docextract extract my_invoice.pdf my_invoice_schema.json
+```
+
+## Quickstart — Python API
+
+```python
+from docextract import Schema, Field, LLMClient, DocumentParser
+
+schema = Schema(
+    name="Invoice",
+    fields=[
+        Field(name="invoice_number", description="The invoice number", required=True),
+        Field(name="total_price", description="Total amount due", type="number", required=True),
+    ],
+)
+
+client = LLMClient(model="gpt-4o-mini", api_key="sk-...")
+# or: LLMClient(base_url="http://localhost:11434/v1", api_key="ollama", model="llama3.2")
+
+parser = DocumentParser(client=client)
+
+with open("invoice.pdf", "rb") as f:
+    result = parser.extract(f.read(), schema)
+
+print(result["invoice_number"])  # {'value': 'INV-9011', 'confidence': 'high', 'flags': ['grounded']}
+```
+
+## Full documentation
+
+- [Getting Started](docs/getting-started.md) — step-by-step install, CLI, and API walkthroughs
+- [Schema Guide](docs/schema-guide.md) — every field option (`type`, `required`, `pattern`, `enum`, `sub_fields`, few-shot `examples`), for JSON, YAML, and plain-English authoring
+- [Output & Validation](docs/output-format.md) — the full result shape, what each confidence flag means, and how to write custom cross-check rules
+- [Architecture](docs/architecture.md) — diagrams of the pipeline, the module dependency graph, and where to plug in a contribution
+- [Project spec](document-extractor-spec.md) — architecture, phased roadmap, honest competitive positioning
+
+Want to contribute? Start with [docs/architecture.md](docs/architecture.md) for the map, then [CONTRIBUTING.md](CONTRIBUTING.md) for the process.
+
+## Status
+
+Core extraction, grounding, chunking, both CLI/API paths, and real packaging (`pip install -e .` installs a working `docextract` command and a proper `docextract.*` import namespace — verified with a from-scratch build and a clean-virtualenv install) are implemented and tested (74 tests, `pytest -v`). Not yet done: actually publishing to PyPI and a hosted API — see [document-extractor-spec.md](document-extractor-spec.md) for the roadmap.

fastdocparse-0.1.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+docextract/__init__.py,sha256=o7Zr_o8-BbVdp_G0g0tI0weqnmvgbhrW-CTQtjuSS6Y,1660
+docextract/cache.py,sha256=vhVlCbef7Zz554Ur6eawpJBfvmp85S8PYUh1XI9hj2A,3030
+docextract/cli.py,sha256=6XxdTCoy999bun_hzB7HMqNO8hKnTdCS2Z4vDlhPPO4,6707
+docextract/config.py,sha256=ptXseRewPutmOB8JkJFoHfDlCG5rbuLqvClLHafs_QA,2021
+docextract/example_schemas.py,sha256=kxrPHIXpCKyZrzollVd6HtBFGnOT5q2YcdksV6a-yIc,414
+docextract/grounding.py,sha256=wbmmXOWnKWrsQWIML2fVYKuI0xqjc3UL2tYKPJ4plhc,11773
+docextract/json_repair.py,sha256=CYpUHw2GMr34oXQiPSYYRaCGsny8V4cPKCB9-YatmAA,2475
+docextract/llm_client.py,sha256=5j4oVRsNW3M-KwzQL3vWA9cr3I1CEVubUfV23LkGmUY,3462
+docextract/ocr_engine.py,sha256=IFtDccMozoUJSvrfZdDnbMmK7BjP2VGIiNanbb98Ji0,3518
+docextract/parser.py,sha256=qmZhI6ZOYQGjtrcnUcIonQl4vLKntwvxzVSThDY2T04,13322
+docextract/pdf_utils.py,sha256=ubjLDK0xrlDKb-TElVCNqwoJ0EwBwBjDcC0CwiKIgJQ,9915
+docextract/prompt_compiler.py,sha256=Chah4Fy05jgcYu5dNJNLnTAUF-tvjrZ2-DzpzNyxXVA,4078
+docextract/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docextract/result.py,sha256=HHsT84DEwVyE9ILgwYB11bbiuqcMD4mdSvJw-wsXK6g,1348
+docextract/schema.py,sha256=emooO7tkh9br5ycwVPBfKlrqjjvVIkzU6QWk5qTwEQo,3683
+docextract/schema_compiler.py,sha256=5MwAOtuzDQlCtNxvSYRpHGOgmEc0WbKUYaYrk9WaGr0,2992
+docextract/schemas/invoice.json,sha256=Um3GV_4fLcixhSqs1FeK9SF463qvF7zcdl-eV62g0HE,2779
+docextract/schemas/shipment_manifest.json,sha256=g8qAs-2GFkL3PzFOxDUeGps_Sn1-8VwpOiCbjdoh-cY,1067
+fastdocparse-0.1.0.dist-info/licenses/LICENSE,sha256=pmOG2pg2FX08pkVqOpjolZxKXQNk6u0ZDGuOtUtoWH4,1071
+fastdocparse-0.1.0.dist-info/METADATA,sha256=2Xrk2UEl8njs95u_Q7uGNoED2AwFm4JLzfcHrE6tcW4,6291
+fastdocparse-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+fastdocparse-0.1.0.dist-info/entry_points.txt,sha256=8QsCzit5mgKHi_H1-8GNP5uvCZDYnZNEF8vy9BV_ugs,50
+fastdocparse-0.1.0.dist-info/top_level.txt,sha256=17vpR7l-bwzr5okQuOGZJcj33NQJqXOFIVqwxQdnatU,11
+fastdocparse-0.1.0.dist-info/RECORD,,

fastdocparse-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fastdocparse-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+docextract = docextract.cli:app

fastdocparse-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pranjal Parmar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastdocparse-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+docextract