kaos-pdf 0.1.0__tar.gz

kaos_pdf-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+*.egg-info/
+dist/
+build/
+htmlcov/
+coverage.xml

kaos_pdf-0.1.0/CHANGELOG.md

@@ -0,0 +1,294 @@
+# 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.0] — 2026-05-20
+
+### Released
+
+- 0.1.0 GA — WU-L of GA plan. First stable release. Public API frozen.
+- Pin floor raised to `>=0.1.0,<0.2` across all kaos-* runtime and
+  optional dependencies. Refreshed `uv.lock` to pick up the 0.1.0
+  line of every upstream.
+
+### Internal
+
+- WU-L of the 0.1.0 GA plan
+  (`kaos-modules/docs/plans/2026-05-20-0.1.0-ga-plan.md`).
+
+
+## [0.1.0rc1] — 2026-05-20
+
+### Changed
+
+- Pin floor raised to `>=0.1.0rc1,<0.2` across kaos-* runtime and
+  optional dependencies (`kaos-core`,
+  `kaos-content[images,layout,markdown]`, `kaos-nlp-core`).
+  Refreshed `uv.lock` to pick up the rc1 line of every upstream.
+
+### Internal
+
+- WU-J of the 0.1.0 GA plan
+  (`kaos-modules/docs/plans/2026-05-20-0.1.0-ga-plan.md`).
+  Release candidate; freezes the public API for `kaos-pdf`
+  ahead of 0.1.0 GA.
+
+
+## [0.1.0a8] — 2026-05-20
+
+### Changed
+
+- **kaos-core floor raised to `>=0.1.0a12`** (post-URI-redesign +
+  Capability type). WU-F.4 of the 0.1.0 GA plan; catch-up to
+  kaos-core 0.1.0a12. No public API changes in kaos-pdf.
+- Refresh `uv.lock`: kaos-core 0.1.0a10 -> 0.1.0a12, kaos-content
+  0.1.0a11 -> 0.1.0a12, kaos-nlp-core 0.1.0a2 -> 0.1.0a8, ruff
+  0.15.12 -> 0.15.13, ty 0.0.34 -> 0.0.36.
+
+## [0.1.0a7] — 2026-05-18
+
+### Added
+
+- **`kaos-pdf-search-document` result dicts** now include
+  `path: list[str]` per hit — the structural breadcrumb
+  (root-first, INCLUDING the immediate section). For PDFs with an
+  embedded outline the path carries the chain of enclosing heading
+  texts; for outline-less PDFs (the common case) the path is empty,
+  which is the explicit "no structural identifier available"
+  contract. Downstream agents MUST NOT invent section identifiers
+  for hits with empty `path`. See
+  `kaos-modules/docs/plans/persona-matrix-followups.md` §4.
+
+### Changed
+
+- **kaos-content floor raised to `>=0.1.0a11`** to pick up the
+  structural-breadcrumb contract on `SearchResult.path` and
+  `DocumentView.block_path()`. Pass-through for kaos-pdf internals
+  (the search tool just forwards `r.path` through to its result
+  dict).
+
+## [0.1.0a6] — 2026-05-17
+
+### Changed
+
+- **kaos-core floor raised to `>=0.1.0a10`** to pick up the URI
+  contract redesign (bare names route through
+  `context.default_vfs_namespace`; `file://` and `vfs://` schemes).
+  See `kaos-modules/docs/plans/uri-contract-redesign.md`. The 6
+  file-input PDF tools route through `resolve_input_path` as
+  pass-throughs.
+
+## [0.1.0a5] — 2026-05-17
+
+### Changed
+
+- **All six file-input MCP tools now resolve their `path` argument
+  through `kaos_core.path_resolver.resolve_input_path()`** instead of
+  raw `Path(p).exists()` against the process CWD. The affected tools
+  are `kaos-pdf-extract-parse`, `kaos-pdf-extract-page-text`,
+  `kaos-pdf-render-page`, `kaos-pdf-metadata`, `kaos-pdf-get-outline`,
+  and `kaos-pdf-classify-page`. Each tool's `path` parameter now
+  accepts three input shapes — an absolute filesystem path
+  (unchanged), a `kaos://artifacts/<id>` URI returned by a previous
+  extract/materialise tool in the same session, or a relative path
+  that resolves through the session VFS (e.g. files uploaded through
+  a host UI's chat panel). The new
+  `kaos_pdf._path_resolver.resolve_pdf_input()` async context manager
+  centralises the call and constrains accepted mime types to
+  `application/pdf`. Existing absolute-path callers — every CLI
+  invocation, every fixture-based test — continue to work as a
+  passthrough; only the previously-broken VFS / artifact paths are
+  affected. `kaos-pdf-search-document` was already artifact-first via
+  `artifact_id` and is unchanged. (Stage 2 of
+  `kaos-modules/docs/plans/vfs-blind-tools-audit-and-fix-plan.md`,
+  filed after the production incident in single-user-chat session
+  `01KRVYAEA3B1HG95DBAG6H0DJ3` where five uploaded NDA `.docx` files
+  routed through the SPA returned `File not found` from every tool
+  call and the agent then fabricated a legal-analysis table citing
+  those files — the same failure class affected kaos-pdf for any
+  PDF uploaded into the session VFS.)
+
+### Added
+
+- `kaos_pdf._path_resolver.resolve_pdf_input()` — internal async
+  context manager wrapping `kaos_core.path_resolver.resolve_input_path`
+  with the PDF mime allow-list and a stub `KaosContext` for CLI
+  callers. Tools call it instead of `Path(...).exists()`.
+- `ParsePDFTool` now threads the source-artifact id (when the input
+  was a `kaos://artifacts/<id>` URI) into both the parsed-document
+  manifest's metadata (`source_artifact_id` / `source_body_uri`) and
+  the response `structured_content` so downstream tools can trace the
+  parsed `ContentDocument` back to its source PDF artifact without
+  having to re-resolve the original chat scrollback.
+- Every refactored tool's `path` parameter schema now describes the
+  three accepted input shapes (absolute path, `kaos://artifacts/<id>`,
+  session-VFS relative path) so an LLM inspecting the schema can
+  discover that bare artifact URIs are accepted without reading the
+  source.
+
+### Dependencies
+
+- Bumped `kaos-core` requirement from `>=0.1.0a3,<0.2` to
+  `>=0.1.0a9,<0.2` to pick up `kaos_core.path_resolver`.
+
+## [0.1.0a4] — 2026-05-15
+
+### Added — tool-group registration entry points (PRD PR 1)
+
+- **`register_pdf_documents_tools(runtime)`** — registers the 7
+  read-only PDF tools (parsers, extractors, renderers, metadata
+  inspectors, outline + classification). This is the entry point a
+  consumer of the SessionToolSet `documents` group should call.
+- **`register_pdf_authoring_tools(runtime)`** — public surface for
+  future `kaos-pdf-write-*` writers, mutators, redactors. Currently
+  registers 0 tools; the stable function exists so the
+  SessionToolSet `authoring` group has a registration entry point
+  before writers ship.
+- **`register_pdf_tools(runtime)`** is now a backward-compatible
+  union of the two — callers that previously got 7 tools continue
+  to get 7. The wrapper composes the new entry points so a future
+  authoring writer registered into one half flows automatically
+  into the union.
+
+The split is motivated by
+`kaos-modules/docs/internal/dynamic-tool-planning-prd.md` §4
+("PR 1 — catalog expansion"). It is purely additive: no existing
+function signature, tool name, schema, or behavior changes.
+
+## [0.1.0a3] — 2026-05-15
+
+### Fixed
+
+- **`kaos-pdf-extract-parse`'s `pages` parameter now declares its
+  element type.** Previously the schema was `type=array` with no
+  `items` declaration, which OpenAI's strict JSON Schema validator
+  rejected with HTTP 400 `invalid_function_parameters`. The entire
+  tool catalog for the turn was lost, leaving the agent to
+  hallucinate answers. Now `items: {type: "integer", minimum: 0}` so
+  the LLM gets a precise contract (0-based page indices, no
+  negative values). kaos-core 0.1.0a7's defensive `items: {}` floor
+  is also in play as belt + suspenders.
+
+### Security
+
+- **vulture (dead-code scan) now runs in pre-commit + CI alongside
+  the existing bandit job.** New `vulture` hook in
+  ``.pre-commit-config.yaml`` mirrored by a new ``vulture (dead-code
+  scan)`` job in ``security.yml``. `--min-confidence 100` with the
+  shared `--ignore-names` list for names vulture can't infer from
+  the import graph (framework callbacks, OAuth/OIDC field names,
+  signal handlers, MCP `_meta` keys). Also lands the existing
+  bandit hook in pre-commit (it was only in CI before). Both pass
+  clean. Mirrors the rollout from kaos-core.
+### Changed
+
+- **uv.lock is now tracked in git.** Previously gitignored at v0.1.0a1
+  because the ``[mcp]`` optional extra (and the ``kaos-mcp`` dev
+  dependency) referenced a sibling not yet on PyPI; ``uv lock``
+  couldn't resolve them. ``kaos-mcp`` shipped (0.1.0a2), so the
+  original gating reason no longer applies. Tracking the lockfile
+  gives reproducible local dev environments, lets Dependabot surface
+  sibling-version bumps as PRs, and makes the supply-chain pin set
+  publicly auditable. Mirrors the org-wide convention being adopted
+  across all 16 kaos-* repos.
+
+## [0.1.0a2] — 2026-05-08
+
+CI supply-chain hardening (audit-02 F7) and documentation accuracy
+(audit-02 F8). No source code or public API changes.
+
+### Security
+
+- **F7: CI supply-chain hardening.** `.github/workflows/security.yml`
+  pins the gitleaks Docker image to `v8.21.2` (no longer tracking
+  `:latest`), adds a Bandit static-analysis job (medium severity /
+  medium confidence, AST-level — `B101,B404,B603,B607` skipped because
+  pytest assertions, subprocess use, and known-safe partial-path
+  invocations are intentional), and runs the integration suite on
+  `schedule` and `workflow_dispatch` so cross-package regressions
+  surface against `main` even though the unit gate stays the PR fast
+  path. SHA-pinning of GitHub Actions themselves remains a follow-up;
+  the existing `.github/dependabot.yml` `github-actions` ecosystem PRs
+  continue to keep tag-pinned actions current.
+
+### Changed
+
+- **F8: `SECURITY.md` rewritten to match the actual surface.** The
+  previous file was the cross-package template — it referenced
+  `ProgramOfThought`, `batch_run`, the semantic cache, and Program v3
+  envelope JSON, all of which live in `kaos-llm-core` / `kaos-agents`,
+  not `kaos-pdf`. The new file documents the real boundaries: PDF
+  input handling (malformed / encrypted / oversize / metadata),
+  Tool-layer validation, the global PDFium lock, OCR / table-extraction
+  subprocess wrappers, and the OIDC release pipeline. Out-of-scope
+  items now correctly list third-party dependencies (`pypdfium2`,
+  `pillow`, `pytesseract`, `camelot-py`, `tabula-py`) and the bundled
+  PDFium binary.
+
+## [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.0/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.0/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.