kaos-pdf 0.1.0a1__tar.gz

kaos_pdf-0.1.0a1/.gitignore

@@ -0,0 +1,17 @@
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+*.egg-info/
+dist/
+build/
+htmlcov/
+coverage.xml
+# uv.lock is gitignored at v0.1.0a1 because the [mcp] optional extra
+# and the kaos-mcp dev dep reference a sibling package not yet on
+# PyPI; uv lock can't resolve them. Re-track when kaos-mcp ships.
+uv.lock

kaos_pdf-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,70 @@
+# Changelog
+
+All notable changes to `kaos-pdf` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0a1] — 2026-05-07
+
+First public alpha. Apache-2.0. Earlier internal versions were proprietary.
+
+### Added
+
+- **PDF extraction pipeline** built on `pypdfium2` (Apache-2.0): produces
+  a `kaos-content` `ContentDocument` AST with provenance (source URI,
+  1-based page, bounding box, extractor name, confidence) on every node.
+  PDFium calls are serialised through a global lock so the library is
+  safe under threaded executors. See `docs/THREAD_SAFETY.md`.
+- **Public Python API** — `extract_pdf`, `extract_pdf_bytes`,
+  `extract_pdf_with_tables`, `extract_page_text`, `render_page`,
+  `get_page_count`, `get_pdf_metadata`, `get_pdf_outline`,
+  `classify_document`, `classify_page`, plus the re-exported
+  `search_document` / `SearchResult` / `SearchResults` from
+  `kaos-content`. `kaos_pdf.__all__` enumerates the surface.
+- **Typed result models** — `PdfMetadata` and `PdfOutlineEntry`
+  `@dataclass(frozen=True, slots=True)` types. Sparse `to_dict()`
+  (None fields omitted) preserves the wire format for JSON consumers.
+  `page_count` is carried directly on `PdfMetadata`.
+- **Seven MCP tools** registered via `register_pdf_tools(runtime)`
+  (requires `kaos-mcp` from source until that package ships on PyPI):
+  `kaos-pdf-extract-parse`, `kaos-pdf-extract-page-text`,
+  `kaos-pdf-render-page`, `kaos-pdf-metadata`,
+  `kaos-pdf-search-document`, `kaos-pdf-get-outline`,
+  `kaos-pdf-classify-page`. All seven are read-only / idempotent /
+  non-destructive / non-open-world. Every `ToolResult.create_error()`
+  call site returns a three-part recovery hint (what / how to fix /
+  alternative tool) for LLM self-correction.
+- **Optional extras**:
+  - `[ocr]` — `pytesseract` engine for scanned PDFs (requires the
+    system `tesseract` binary). `OCRMode` is the `extract_pdf(ocr=...)`
+    setting; `OCREngine` is the engine ABC; `TesseractEngine` is the
+    Apache-2.0 default. OCR paragraphs carry `Provenance.confidence`.
+  - `[tables]` — `pdfplumber` engine (MIT, pure Python — no Java, no
+    GPU) for borderless and multi-line tables. Extracted tables become
+    `TabularDocument` with typed columns; live in the body with
+    `Provenance.extractor = "kaos-pdf/tables/{engine}"`.
+  - `[nlp]` — `kaos-nlp-core` for BM25 sentence-level search via
+    `search_document(..., level="sentence")`.
+- **Two CLI entry points** — `kaos-pdf` (admin) and `kaos-pdf-serve`
+  (MCP server, stdio + streamable HTTP). Every structured subcommand
+  supports `--json` for machine-readable output. CLI uses 1-based page
+  numbers; the Python API is 0-based.
+- **Errors** — `KaosPdfError` base + `PdfNotFoundError`,
+  `PdfExtractionError`, `PdfRenderError`. Tools translate these into
+  `ToolResult.create_error()`.
+
+### Notes
+
+- VLM page programs (describe / classify / VLM-OCR) live in
+  `kaos-llm-core[vision]` ≥ 0.1.0a3, not in `kaos-pdf`. The split
+  keeps the extraction → LLM dependency direction one-directional.
+- `kaos-pdf` does not and will not depend on AGPL or GPL libraries.
+  This rules out Surya for OCR and camelot-lattice / Tabula for
+  tables.
+- The `[mcp]` extra is intentionally not declared at 0.1.0a1 because
+  `kaos-mcp` is not yet on PyPI; `uv lock` refuses to resolve any
+  declared extra whose package is unresolvable. The extra returns
+  once `kaos-mcp` ships.

kaos_pdf-0.1.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 273 Ventures LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

kaos_pdf-0.1.0a1/NOTICE

@@ -0,0 +1,8 @@
+kaos-pdf
+Copyright 2026 273 Ventures LLC.
+
+This product includes software developed at 273 Ventures LLC
+(https://273ventures.com).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file
+distributed with this software for the full text of the license.

kaos_pdf-0.1.0a1/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: kaos-pdf
+Version: 0.1.0a1
+Summary: PDF extraction and document processing for KAOS — structured AST output with provenance
+Project-URL: Homepage, https://kelvin.legal
+Project-URL: Documentation, https://docs.kelvin.legal
+Project-URL: Repository, https://github.com/273v/kaos-pdf
+Project-URL: Issues, https://github.com/273v/kaos-pdf/issues
+Project-URL: Changelog, https://github.com/273v/kaos-pdf/blob/main/CHANGELOG.md
+Author-email: 273 Ventures LLC <it@273ventures.com>
+Maintainer-email: Michael Bommarito <mike@273ventures.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: extraction,kaos,mcp,ocr,pdf,pypdfium2,tables
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: kaos-content[images,layout,markdown]<0.2,>=0.1.0a1
+Requires-Dist: kaos-core<0.2,>=0.1.0a3
+Requires-Dist: pypdfium2>=4.30.0
+Provides-Extra: nlp
+Requires-Dist: kaos-nlp-core<0.2,>=0.1.0a2; extra == 'nlp'
+Provides-Extra: ocr
+Requires-Dist: pytesseract>=0.3.10; extra == 'ocr'
+Provides-Extra: tables
+Requires-Dist: pdfplumber>=0.11.0; extra == 'tables'
+Description-Content-Type: text/markdown
+
+# kaos-pdf
+
+> **Part of [Kelvin Agentic OS](https://kelvin.legal) (KAOS)** — open agentic
+> infrastructure for legal work, built by
+> [273 Ventures](https://273ventures.com).
+> See the [full KAOS package map](https://github.com/273v) for the rest of the stack.
+
+[![PyPI - Version](https://img.shields.io/pypi/v/kaos-pdf)](https://pypi.org/project/kaos-pdf/)
+[![Python](https://img.shields.io/pypi/pyversions/kaos-pdf)](https://pypi.org/project/kaos-pdf/)
+[![License](https://img.shields.io/pypi/l/kaos-pdf)](https://github.com/273v/kaos-pdf/blob/main/LICENSE)
+[![CI](https://github.com/273v/kaos-pdf/actions/workflows/ci.yml/badge.svg)](https://github.com/273v/kaos-pdf/actions/workflows/ci.yml)
+
+`kaos-pdf` is the PDF-extraction layer of KAOS — it turns a PDF byte stream
+into a typed [`kaos-content`](https://github.com/273v/kaos-content)
+`ContentDocument` AST with provenance (page numbers, bounding boxes,
+extraction confidence) on every node, plus a small set of read-only MCP
+tools for agentic workflows. The engine is
+[`pypdfium2`](https://github.com/pypdfium2-team/pypdfium2) (Apache-2.0)
+and all PDFium calls are serialised through a global lock so the library
+is safe to call from threaded executors. No raw text strings escape — every
+result is an AST node, a typed dataclass, or a `KaosImage`.
+
+The base install is intentionally small: three runtime dependencies
+(`kaos-content[images,layout,markdown]`, `kaos-core`, `pypdfium2`) and no
+compiled native code beyond the PDFium wheel. Heavier capabilities are
+opt-in extras: `[ocr]` adds `pytesseract` for scanned pages (and requires
+a system `tesseract` binary), `[tables]` adds `pdfplumber` (MIT, pure
+Python — no Java, no GPU) for borderless and multi-line tables, and
+`[nlp]` adds `kaos-nlp-core` for BM25 sentence-level search. VLM page
+programs (describe / classify / OCR-via-VLM) live in
+`kaos-llm-core[vision]` ≥ 0.1.0a3 — they were moved out of `kaos-pdf` to
+keep the extraction → LLM dependency direction one-directional. We do not
+and will not depend on AGPL or GPL libraries (this rules out Surya for
+OCR and camelot-lattice / Tabula for tables).
+
+## Install
+
+```bash
+uv add kaos-pdf
+# or
+pip install kaos-pdf
+
+# OCR for scanned PDFs (requires system tesseract binary)
+uv add 'kaos-pdf[ocr]'
+
+# Structured table extraction via pdfplumber
+uv add 'kaos-pdf[tables]'
+
+# BM25 sentence-level search via kaos-nlp-core
+uv add 'kaos-pdf[nlp]'
+```
+
+`kaos-pdf` requires Python **3.13** or newer (3.14 is supported). The
+package is pure Python — the only native code is the PDFium wheel shipped
+by `pypdfium2`, which has prebuilt wheels for Linux, macOS, and Windows
+on x86_64 and arm64.
+
+## Quick start
+
+Extract a PDF into the document AST, render a page, and search for a term:
+
+```python
+from kaos_pdf import (
+    extract_pdf,
+    get_pdf_metadata,
+    get_pdf_outline,
+    render_page,
+    search_document,
+)
+
+# Parse the whole document into a kaos-content ContentDocument
+doc = extract_pdf("contract.pdf")
+print(len(doc.body), "top-level blocks")
+
+# Typed metadata (PdfMetadata dataclass; sparse to_dict() for JSON)
+meta = get_pdf_metadata("contract.pdf")
+print(meta.page_count, meta.title, meta.author)
+
+# Outline / bookmarks (list[PdfOutlineEntry], also typed)
+for entry in get_pdf_outline("contract.pdf"):
+    print("  " * entry.level, entry.title, "p", entry.page)
+
+# Render the first page as a 300-DPI PIL image (returned as KaosImage)
+image = render_page("contract.pdf", page_number=0, dpi=300)
+image.pil.save("page-1.png")
+
+# AST-grounded search — paragraph-level by default
+hits = search_document(doc, "indemnification", top_k=5)
+for hit in hits.results:
+    print(f"score={hit.score:.2f} :: {hit.text[:80]}")
+```
+
+Every node in the returned `ContentDocument` carries a `Provenance`
+(source path, 1-based page, bounding box, extractor name, confidence)
+so downstream consumers — citation verifiers, redaction tooling,
+labelers — can ground answers back to the original PDF.
+
+## Concepts
+
+The package is a thin, typed surface over `pypdfium2`. The most important
+entries:
+
+| Concept | What it is |
+|---|---|
+| **`extract_pdf(path, *, pages=None, ocr="never", tables="geometric", extract_images=False, image_src_builder=...)`** | Primary entry point. Returns a `ContentDocument`. `pages` selects 0-based indices; `ocr` is `"never"` / `"auto"` / `"always"`; `tables` is `"geometric"` / `"engine"` / `"disabled"`; `image_src_builder` lets callers control the image URI policy (default inlines as `data:` URLs). |
+| **`extract_pdf_bytes(data, ...)` / `extract_pdf_with_tables(path, ...)`** | Bytes-input variant and the sidecar form that returns `(ContentDocument, TabularDocument)` when you want tables out of the body. |
+| **`render_page(path, page_number, *, dpi=300, grayscale=False)`** | Renders a single page (0-based) to a `KaosImage` (PIL + DPI + provenance). |
+| **`extract_page_text(path, page_number)` / `get_page_count(path)`** | Lightweight per-page text + page-count helpers that skip full AST construction. |
+| **`PdfMetadata` / `PdfOutlineEntry`** | `@dataclass(frozen=True, slots=True)` result types returned by `get_pdf_metadata()` and `get_pdf_outline()`. Sparse `to_dict()` (None fields omitted) preserves the historical wire format. `page_count` lives on `PdfMetadata` directly — no extra `get_page_count()` call needed. |
+| **`classify_document(path)` / `classify_page(path, page_number)`** | Lightweight document/page-type heuristics (e.g. `text`, `scanned`, `mixed`). |
+| **`search_document(doc, query, *, top_k=10, level="paragraph")`** | Re-exported from `kaos-content`. AST-grounded ranked search returning `SearchResults` with `total_matches` / `has_more` for pagination. `level="sentence"` requires the `[nlp]` extra. |
+| **`OCRMode` / `OCREngine` / `TesseractEngine`** | OCR pluggability. `OCRMode` is the `extract_pdf(ocr=...)` setting; `OCREngine` is the engine ABC; `TesseractEngine` is the Apache-2.0 default (install with `[ocr]` + system tesseract). OCR paragraphs carry `Provenance.confidence` so verifiers can weight them. |
+| **`TableMode` / `TableEngine` / `ExtractedTable` / `TableResult`** | Table pluggability. `pdfplumber` is the MIT default behind `[tables]`. Extracted tables become `TabularDocument` with typed columns and live in the body with `Provenance.extractor = "kaos-pdf/tables/{engine}"`. |
+| **`ParsePDFTool`, `GetPageTextTool`, `RenderPageTool`, `PDFMetadataTool`, `SearchDocumentTool`, `GetOutlineTool`, `ClassifyPageTool`** | The seven `KaosTool` subclasses exposed over MCP as `kaos-pdf-extract-parse`, `-extract-page-text`, `-render-page`, `-metadata`, `-search-document`, `-get-outline`, `-classify-page`. All seven are `readOnly`, `idempotent`, non-destructive, non-open-world. Register with `register_pdf_tools(runtime)`. |
+| **Errors (`KaosPdfError`, `PdfNotFoundError`, `PdfExtractionError`, `PdfRenderError`)** | Dedicated exception hierarchy. MCP tools translate these into `ToolResult.create_error()` with the documented three-part recovery hint (what / how to fix / alternative tool). |
+
+## CLI
+
+`kaos-pdf` ships two entry-point scripts. Every structured command on
+the admin CLI supports `--json` for machine-readable output piped to
+other agents:
+
+```bash
+kaos-pdf --help                                     # admin CLI
+kaos-pdf-serve --help                               # MCP server
+
+kaos-pdf info contract.pdf --json                   # metadata + page count + classification
+kaos-pdf outline contract.pdf --json                # PDF bookmarks (falls back to detected headings)
+kaos-pdf page contract.pdf 3 --json                 # plain text from a single page (1-based)
+kaos-pdf extract contract.pdf -f markdown -p 1-5    # full AST → markdown / text / json / html
+kaos-pdf render contract.pdf 1 --dpi 300 -o p1.png  # render a page as PNG
+kaos-pdf classify contract.pdf --page 1 --json      # document- or page-level type
+kaos-pdf search contract.pdf "indemnification" -k 5 # AST-grounded ranked search
+
+kaos-pdf-serve                                      # stdio (Claude Code / Desktop)
+kaos-pdf-serve --http --port 8000                   # streamable HTTP
+```
+
+The admin CLI uses 1-based page numbers (consistent with how the file
+opens in any PDF viewer) and translates internally to the 0-based indices
+the Python API uses. `kaos-pdf-serve` exposes the seven MCP tools listed
+in **Concepts** above.
+
+## Compatibility & status
+
+| Aspect | |
+|---|---|
+| **Python** | 3.13, 3.14 |
+| **OS** | Linux, macOS, Windows (pure-Python wheel; the only native code is the PDFium wheel shipped by `pypdfium2`) |
+| **Maturity** | Alpha (`Development Status :: 3 - Alpha`). The public API is documented in `kaos_pdf.__all__`. |
+| **Stability policy** | Pre-1.0: minor bumps may change behaviour. Every change is documented in [`CHANGELOG.md`](CHANGELOG.md). The MCP tool surface (`kaos-pdf-*` names) and the `KAOS_PDF_*` environment-variable namespace are public API and follow the same policy. |
+| **Test coverage** | 340 unit tests plus a small integration tier hitting the MCP wire end-to-end. Bounded unit gate (`pytest tests/unit -q --no-cov`) finishes in ~35s. |
+| **Type checker** | Validated with [`ty`](https://docs.astral.sh/ty/), Astral's Python type checker. |
+
+## Companion packages
+
+`kaos-pdf` is one of the packages in the
+[Kelvin Agentic OS](https://kelvin.legal). The broader stack:
+
+| Package | Layer | What it does |
+|---|---|---|
+| [`kaos-core`](https://github.com/273v/kaos-core) | Core | Foundational runtime, MCP-native types, registries, execution engine, VFS |
+| [`kaos-content`](https://github.com/273v/kaos-content) | Core | Typed document AST: Block/Inline, provenance, views |
+| [`kaos-mcp`](https://github.com/273v/kaos-mcp) | Bridge | FastMCP server, `kaos` management CLI, MCP resource templates |
+| [`kaos-pdf`](https://github.com/273v/kaos-pdf) | Extraction | PDF → AST with provenance |
+| [`kaos-web`](https://github.com/273v/kaos-web) | Extraction | Web extraction, browser automation, search, domain intelligence |
+| [`kaos-office`](https://github.com/273v/kaos-office) | Extraction | DOCX / PPTX / XLSX readers + writers to AST |
+| [`kaos-tabular`](https://github.com/273v/kaos-tabular) | Extraction | DuckDB-powered SQL analytics |
+| [`kaos-source`](https://github.com/273v/kaos-source) | Data | Government + financial data connectors (Federal Register, eCFR, EDGAR, GovInfo, PACER, GLEIF) |
+| [`kaos-llm-client`](https://github.com/273v/kaos-llm-client) | LLM | Multi-provider LLM transport |
+| [`kaos-llm-core`](https://github.com/273v/kaos-llm-core) | LLM | Typed LLM programming (Signatures, Programs, Optimizers) |
+| [`kaos-nlp-core`](https://github.com/273v/kaos-nlp-core) | Primitives (Rust) | High-performance NLP primitives |
+| [`kaos-nlp-transformers`](https://github.com/273v/kaos-nlp-transformers) | ML | Dense embeddings + retrieval |
+| [`kaos-graph`](https://github.com/273v/kaos-graph) | Primitives (Rust) | Graph algorithms + RDF/SPARQL |
+| [`kaos-ml-core`](https://github.com/273v/kaos-ml-core) | Primitives (Rust) | Classical ML on the document AST |
+| [`kaos-citations`](https://github.com/273v/kaos-citations) | Legal | Legal citation extraction, resolution, verification |
+| [`kaos-agents`](https://github.com/273v/kaos-agents) | Agentic | Agent runtime, memory, recipes |
+| [`kaos-reference`](https://github.com/273v/kaos-reference) | Sample | Reference module for module authors |
+
+Packages depend on `kaos-core`; everything else is opt-in. Mix and match the
+ones you need.
+
+## Development
+
+```bash
+git clone https://github.com/273v/kaos-pdf
+cd kaos-pdf
+uv sync --group dev
+```
+
+Install pre-commit hooks (recommended — they run the same checks as CI on
+every commit, scoped to staged files):
+
+```bash
+uvx pre-commit install
+uvx pre-commit run --all-files     # one-time full sweep
+```
+
+Manual QA commands (the same set CI runs):
+
+```bash
+uv run ruff format --check kaos_pdf tests
+uv run ruff check kaos_pdf tests
+uv run ty check kaos_pdf tests
+uv run pytest tests/unit -q --no-cov
+```
+
+## Build from source
+
+```bash
+uv build
+uv pip install dist/*.whl
+python -c "import kaos_pdf; print(kaos_pdf.__version__)"  # smoke import
+```
+
+## Contributing
+
+Issues and pull requests are welcome. By contributing you certify the
+[Developer Certificate of Origin v1.1](https://developercertificate.org/) —
+sign every commit with `git commit -s`. Please open an issue before starting
+on a non-trivial change so we can align on scope.
+
+## Security
+
+For security issues, **please do not file a public issue**. Report privately
+via [GitHub Private Vulnerability Reporting](https://github.com/273v/kaos-pdf/security/advisories/new)
+or email **security@273ventures.com**. See [SECURITY.md](SECURITY.md) for the
+full disclosure policy.
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+Copyright 2026 [273 Ventures LLC](https://273ventures.com).
+Built for [kelvin.legal](https://kelvin.legal).