inklight 0.1.0__tar.gz

inklight-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.coverage
+htmlcov/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.scratch-home/
+.scratch-out/
+bench/last_run.txt
+*.db
+*.db-wal
+*.db-shm
+.env

inklight-0.1.0/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow [SemVer](https://semver.org/).
+
+## [0.1.0] — 2026-10-23
+
+First public release candidate.
+
+### Added
+- Document library: incremental ingest (unchanged files skipped, identical content reuses OCR), SQLite +
+  FTS5 index, layout-aware chunks, classification, prompt-injection scan, re-index and delete.
+- Indra OCR backend (PDF text layer first, OCR where needed; PNG/JPEG/TIFF/BMP/WebP), plain-text and
+  Markdown reader, pluggable engine registry.
+- Typed field extraction with page/box provenance, confidence, warnings and `subtotal + tax = total`
+  checks; schema files in three formats.
+- Bounded agent: rule planner, 11 allow-listed tools, step limits, time budgets, cancellation, retries, trace.
+- Small local models on ONNX Runtime: 66M extractive reader, 33M embedder (hybrid search), optional
+  135M writer with grounding checks. Optional OpenAI-compatible remote model with quote verification.
+- CLI (`process, ask, extract, search, docs, show, remove, reindex, history, watch, serve, tools, doctor, models`).
+- Local web workspace: upload, library, page preview with evidence highlighting, agent, extraction, search, history, settings.
+- Folder watcher automation.
+- Benchmarks (`bench/`), 128 tests, CI and release workflows, Dockerfile.
+
+### Fixed before release (external review of 478fc3d)
+- Vendor and customer constraints ("invoices from Acme above $5,000") were silently dropped. They are now
+  conditions (`vendor contains "Acme"`), including negation ("not from", "except").
+- `or` between conditions was applied as AND. It now means any. A mix of `and`/`or` is reported instead of guessed.
+- Added `between X and Y` and year conditions ("in 2026").
+- Amounts in different currencies were summed into one number. Money values now carry a `unit`, sums are
+  reported per currency, and filters never compare € amounts with a $ threshold.
+- Requests with words no tool can apply ("paid late", "last month", "top 3", a stray amount) used to return
+  `succeeded`. They now return `partial` and list the words under **Not applied**.
+- Counting with conditions ("how many invoices above $8,000") ignored the conditions.
+- Ambiguous numeric dates (`03/04/2026`) were read silently. They are now flagged, and `[extraction] day_first`
+  sets the order.
+- The currency is read from a label ("TOTAL DUE (USD)") when the amount has no symbol. Added EGP / E£.
+- `grounded()` accepted "Acme owes Bob" against "Bob owes Acme". It now also requires the evidence's order of
+  names and numbers, and is documented as a necessary check, not proof of correctness.
+- Reader answers whose surroundings share no word with the question are penalised.
+
+### Changed
+- Results report confidence twice: `interpretation_confidence` (was the request understood) and
+  `evidence_confidence` (do the documents support it). `confidence` is the lower of the two. Results also
+  carry `interpretation` and `not_understood`, shown in the CLI and the web workspace.
+- Docs: "verified" now explicitly means provenance (the text exists where cited), not semantic correctness.
+- Benchmarks: three invoice layouts instead of one, plus a request-handling score.
+
+### Configuration
+- Config schema version `1`. Configs declaring a newer version are rejected with a clear message.
+  Future migrations will run oldest-first in `config._migrate`.
+- Library database schema version `1` (`meta.schema_version`).

inklight-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 reasonable and customary use in 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 [yyyy] [name of copyright owner]
+
+   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.

inklight-0.1.0/NOTICE

@@ -0,0 +1,15 @@
+Inklight
+Copyright 2026 Mahmoud AboEl-Wfa
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+Inklight uses, but does not include, the following third-party software and models,
+which are installed or downloaded separately under their own licenses:
+
+- Indra OCR (https://github.com/datalab-to/indra), code under Apache-2.0,
+  Copyright Datalab. Its model weights (https://huggingface.co/datalab-to/indra-ocr)
+  are licensed under a modified OpenRAIL-M license with commercial-use restrictions.
+- DistilBERT SQuAD (Apache-2.0), BGE-small-en-v1.5 (MIT) and SmolLM2-135M-Instruct
+  (Apache-2.0), downloaded on request by `inklight models pull`.
+
+See THIRD_PARTY_LICENSES.md for the full audit.

inklight-0.1.0/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.5
+Name: inklight
+Version: 0.1.0
+Summary: Inklight — a local-first, OCR-powered document agent. See documents. Understand meaning. Take action.
+Project-URL: Homepage, https://github.com/MahmoudYahiaAhmed/inklight
+Project-URL: Documentation, https://github.com/MahmoudYahiaAhmed/inklight/tree/main/docs
+Project-URL: Issues, https://github.com/MahmoudYahiaAhmed/inklight/issues
+Project-URL: Changelog, https://github.com/MahmoudYahiaAhmed/inklight/blob/main/CHANGELOG.md
+Project-URL: Source, https://github.com/MahmoudYahiaAhmed/inklight
+Author: Mahmoud AboEl-Wfa
+Maintainer: Mahmoud AboEl-Wfa
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY_LICENSES.md
+Keywords: agent,document-ai,extraction,invoice,local-first,ocr,pdf,rag
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Text Processing :: General
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: fastapi>=0.110
+Requires-Dist: indra-ocr>=1.1
+Requires-Dist: numpy>=1.24
+Requires-Dist: pydantic>=2.6
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: rich>=13
+Requires-Dist: tokenizers>=0.19
+Requires-Dist: typer>=0.12
+Requires-Dist: uvicorn>=0.29
+Provides-Extra: dev
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pymupdf>=1.24; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: remote
+Requires-Dist: httpx>=0.27; extra == 'remote'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MahmoudYahiaAhmed/inklight/main/docs/assets/logo.svg" width="84" alt="Inklight logo">
+</p>
+
+<h1 align="center">inklight</h1>
+
+<p align="center"><b>See documents. Understand meaning. Take action.</b><br>
+A local-first, OCR-powered document agent for Python — fast on a laptop CPU, and it shows its evidence.</p>
+
+<p align="center">
+  <a href="https://github.com/MahmoudYahiaAhmed/inklight/actions/workflows/ci.yml"><img alt="ci" src="https://github.com/MahmoudYahiaAhmed/inklight/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://pypi.org/project/inklight/"><img alt="pypi" src="https://img.shields.io/pypi/v/inklight?style=flat-square&labelColor=0B0F14&color=22D3EE"></a>
+  <img alt="python" src="https://img.shields.io/badge/python-3.11%2B-22D3EE?style=flat-square&labelColor=0B0F14">
+  <img alt="license" src="https://img.shields.io/badge/code-Apache--2.0-F5B544?style=flat-square&labelColor=0B0F14">
+  <img alt="ocr" src="https://img.shields.io/badge/OCR-Indra-22D3EE?style=flat-square&labelColor=0B0F14">
+  <img alt="local" src="https://img.shields.io/badge/runs-offline-F5B544?style=flat-square&labelColor=0B0F14">
+</p>
+
+<p align="center"><img src="https://raw.githubusercontent.com/MahmoudYahiaAhmed/inklight/main/docs/assets/workspace.jpg" width="860" alt="The Inklight workspace: an evidence-backed answer with the source line highlighted on the page"></p>
+
+---
+
+Point Inklight at a folder of PDFs, scans or photos and ask for what you need, in plain language:
+
+```bash
+inklight ask ./invoices "Read all these invoices and create a CSV of vendor, date, tax, and total" --out ./out
+inklight ask ./contracts "Find every contract that expires within 90 days"
+inklight ask ./reports "Compare these reports and explain the differences"
+```
+
+You get an answer **plus the page, line and bounding box it came from**, a confidence score, warnings when
+something looks off, and a trace of every step the agent took.
+
+## Why Inklight
+
+- **Real OCR, on CPU.** Built on [Indra OCR](https://github.com/datalab-to/indra): 43 ms per digital PDF page,
+  98 ms per scanned page on a laptop ([benchmarks](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/docs/BENCHMARKS.md)). Digital PDFs use their text layer
+  first, and OCR runs only where needed.
+- **An agent, not a chatbot wrapper.** It works out the intent, then runs a minimal plan of typed tools
+  (search, extract, filter, calculate, compare, find inconsistencies, summarise, write). Every run has
+  step limits, time budgets, retries and cancellation.
+- **Shows its work, and its limits.** Every result says *how your request was understood* ("vendor contains
+  Acme; total > 5,000 USD") and lists anything it could **not** apply, instead of quietly answering a broader
+  question. Values come from labelled fields, extractive spans or quoted sentences with page and position.
+  A citation proves where a value came from, not that it answers your question, so confidence is reported
+  twice: *understood* (did it read your request right) and *evidence* (OCR, labels, `subtotal + tax = total`).
+  Amounts in different currencies are never added or compared to each other.
+- **Small-model intelligence, measured.** Optional models are each under 200M parameters: a 66M reader that
+  can only point at text in your document, a 33M embedder for search, and an optional 135M writer whose output
+  must be grounded. Calculations and filters are exact Python, not model guesses.
+- **Local and private by default.** No API key needed. Nothing leaves your machine unless you configure a remote model.
+- **Safe with untrusted documents.** "Ignore previous instructions" inside a PDF is treated as data and flagged.
+  The agent has no shell, no code execution, and writes files only where you allow. See [SECURITY.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/SECURITY.md).
+
+## Install
+
+```bash
+pip install inklight            # Python 3.11+, Windows / Linux / macOS, CPU only
+inklight models pull            # optional: 66M reader + 33M embedder (~100 MB, once)
+```
+
+Indra's OCR models (~76 MB) download automatically on the first OCR run. After that, everything works offline.
+
+## 60-second tour
+
+```bash
+inklight process ./documents/                                   # OCR, classify and index (incremental)
+inklight ask ./documents/ "Find all invoices above $5,000"
+inklight extract invoice.pdf --schema invoice.json --format csv
+inklight serve                                                  # web workspace on http://127.0.0.1:8765
+inklight watch ./inbox -r "extract vendor and total as csv" -o ./out   # automation
+```
+
+```python
+from inklight import DocumentAgent
+
+agent = DocumentAgent()
+result = agent.ask("Extract the invoice number, date, and total", files=["invoice.pdf"])
+
+print(result.answer)        # human-readable answer
+print(result.table())       # [{'document': 'invoice.pdf', 'invoice_number': 'INV-2041', 'date': '2026-10-03', 'total': 5616.0}]
+print(result.sources[0])    # name='invoice.pdf' page=1 bbox=(200.4, 325.0, 667.6, 359.5) excerpt='INVOICE #INV-2041' ocr_conf=1.0
+print(result.warnings, result.confidence, result.trace)
+```
+
+More: typed extraction without natural language (`agent.extract(files, fields=[...])` or `schema=`), `ask_async`,
+library management (`agent.library.search/remove/reindex`), and the HTTP API at `/api/docs` when serving.
+See [docs/API.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/docs/API.md).
+
+## What it can do
+
+| You say | Inklight does | Tools |
+|---|---|---|
+| "create a CSV of vendor, date, tax and total" | Typed extraction with provenance, then writes the CSV (with permission) | `extract_fields → write_output` |
+| "contracts that expire within 90 days" | Extracts expiry dates, filters by date window | `extract_fields → filter_records` |
+| "invoices above $5,000" | Exact numeric filter | `extract_fields → filter_records` |
+| "sum of all invoice totals" | Decimal arithmetic, reports missing values | `extract_fields → calculate` |
+| "compare these reports" | Field and line diffs, changed figures (`6% → 17%`) | `compare_documents` |
+| "flag inconsistent customer names" | Fuzzy grouping of variants, arithmetic and date checks | `extract_fields → find_inconsistencies` |
+| "find the paragraph about termination" | Retrieval, then the exact block with its box on the page | `search → cite` |
+| "what was revenue growth in Q2?" | Field shortcut, extractive reader, or best sentence, with citation | `search → answer` |
+| "summarize the reports" | Extractive summaries with page citations | `summarize` |
+
+## How it works
+
+```
+request ─► planner (typed plan, from your words only) ─► bounded runner ─► tools ─► cited answer + what it understood
+                                                                   │
+            library: SQLite + FTS5 (+ vectors) ◄── ingest ◄── Indra OCR (text layer first, OCR where needed)
+```
+
+Details in [docs/ARCHITECTURE.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/docs/ARCHITECTURE.md). The short version of the "200M-parameter" story:
+we measured a 135M model as a planner and it was right 27.5% of the time, so the small models do what small
+models are good at (pointing at evidence, ranking passages) and deterministic code does the rest.
+
+## Configuration
+
+`~/.inklight/config.toml` (see [config.example.toml](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/config.example.toml)) or environment variables such as
+`INKLIGHT_LIMITS__MAX_PAGES=50`. Brain modes:
+- `rules`: no models.
+- `auto` (default): use the small models if they are installed.
+- `local`: require the small models.
+- `models.remote_*`: optional stronger model behind an OpenAI-compatible API, for low-confidence questions.
+
+## Limits, honestly
+
+- OCR quality is Indra's. It is weaker on handwriting, degraded scans, complex tables and some scripts
+  ([Indra's notes](https://github.com/datalab-to/indra)). Low OCR confidence is surfaced on every value.
+- Field labels are English. Ambiguous dates like `03/04/2026` are read month-first.
+- The rule planner covers common document tasks. Unusual phrasing falls back to question answering,
+  or to a remote model if you configured one.
+- Semantic search scans vectors in memory, which suits libraries up to tens of thousands of chunks.
+
+## ⚠ License notice — read before commercial use
+
+Inklight's code is **Apache-2.0**. The **Indra OCR model weights** (downloaded by `indra-ocr`, not
+bundled) use a **modified OpenRAIL-M license**. It is free for research, personal use, and organisations
+under $20M revenue and under $20M funding. It restricts commercial use that **competes with Datalab**.
+A commercial document-AI product built on Inklight + Indra needs a license from
+[Datalab](https://www.datalab.to/pricing), or a different OCR engine (the OCR layer is pluggable).
+Full audit: [THIRD_PARTY_LICENSES.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/THIRD_PARTY_LICENSES.md).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                      # 128 tests, about 1 minute on CPU (downloads Indra models on first run)
+ruff check src tests && mypy src
+python bench/run.py         # reproduces docs/BENCHMARKS.md
+```
+
+See [CONTRIBUTING.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/CONTRIBUTING.md), [CHANGELOG.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/CHANGELOG.md), [CODE_OF_CONDUCT.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/CODE_OF_CONDUCT.md)
+and, for maintainers, [docs/PUBLISHING.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/docs/PUBLISHING.md).

inklight-0.1.0/README.md

@@ -0,0 +1,153 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/MahmoudYahiaAhmed/inklight/main/docs/assets/logo.svg" width="84" alt="Inklight logo">
+</p>
+
+<h1 align="center">inklight</h1>
+
+<p align="center"><b>See documents. Understand meaning. Take action.</b><br>
+A local-first, OCR-powered document agent for Python — fast on a laptop CPU, and it shows its evidence.</p>
+
+<p align="center">
+  <a href="https://github.com/MahmoudYahiaAhmed/inklight/actions/workflows/ci.yml"><img alt="ci" src="https://github.com/MahmoudYahiaAhmed/inklight/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://pypi.org/project/inklight/"><img alt="pypi" src="https://img.shields.io/pypi/v/inklight?style=flat-square&labelColor=0B0F14&color=22D3EE"></a>
+  <img alt="python" src="https://img.shields.io/badge/python-3.11%2B-22D3EE?style=flat-square&labelColor=0B0F14">
+  <img alt="license" src="https://img.shields.io/badge/code-Apache--2.0-F5B544?style=flat-square&labelColor=0B0F14">
+  <img alt="ocr" src="https://img.shields.io/badge/OCR-Indra-22D3EE?style=flat-square&labelColor=0B0F14">
+  <img alt="local" src="https://img.shields.io/badge/runs-offline-F5B544?style=flat-square&labelColor=0B0F14">
+</p>
+
+<p align="center"><img src="https://raw.githubusercontent.com/MahmoudYahiaAhmed/inklight/main/docs/assets/workspace.jpg" width="860" alt="The Inklight workspace: an evidence-backed answer with the source line highlighted on the page"></p>
+
+---
+
+Point Inklight at a folder of PDFs, scans or photos and ask for what you need, in plain language:
+
+```bash
+inklight ask ./invoices "Read all these invoices and create a CSV of vendor, date, tax, and total" --out ./out
+inklight ask ./contracts "Find every contract that expires within 90 days"
+inklight ask ./reports "Compare these reports and explain the differences"
+```
+
+You get an answer **plus the page, line and bounding box it came from**, a confidence score, warnings when
+something looks off, and a trace of every step the agent took.
+
+## Why Inklight
+
+- **Real OCR, on CPU.** Built on [Indra OCR](https://github.com/datalab-to/indra): 43 ms per digital PDF page,
+  98 ms per scanned page on a laptop ([benchmarks](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/docs/BENCHMARKS.md)). Digital PDFs use their text layer
+  first, and OCR runs only where needed.
+- **An agent, not a chatbot wrapper.** It works out the intent, then runs a minimal plan of typed tools
+  (search, extract, filter, calculate, compare, find inconsistencies, summarise, write). Every run has
+  step limits, time budgets, retries and cancellation.
+- **Shows its work, and its limits.** Every result says *how your request was understood* ("vendor contains
+  Acme; total > 5,000 USD") and lists anything it could **not** apply, instead of quietly answering a broader
+  question. Values come from labelled fields, extractive spans or quoted sentences with page and position.
+  A citation proves where a value came from, not that it answers your question, so confidence is reported
+  twice: *understood* (did it read your request right) and *evidence* (OCR, labels, `subtotal + tax = total`).
+  Amounts in different currencies are never added or compared to each other.
+- **Small-model intelligence, measured.** Optional models are each under 200M parameters: a 66M reader that
+  can only point at text in your document, a 33M embedder for search, and an optional 135M writer whose output
+  must be grounded. Calculations and filters are exact Python, not model guesses.
+- **Local and private by default.** No API key needed. Nothing leaves your machine unless you configure a remote model.
+- **Safe with untrusted documents.** "Ignore previous instructions" inside a PDF is treated as data and flagged.
+  The agent has no shell, no code execution, and writes files only where you allow. See [SECURITY.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/SECURITY.md).
+
+## Install
+
+```bash
+pip install inklight            # Python 3.11+, Windows / Linux / macOS, CPU only
+inklight models pull            # optional: 66M reader + 33M embedder (~100 MB, once)
+```
+
+Indra's OCR models (~76 MB) download automatically on the first OCR run. After that, everything works offline.
+
+## 60-second tour
+
+```bash
+inklight process ./documents/                                   # OCR, classify and index (incremental)
+inklight ask ./documents/ "Find all invoices above $5,000"
+inklight extract invoice.pdf --schema invoice.json --format csv
+inklight serve                                                  # web workspace on http://127.0.0.1:8765
+inklight watch ./inbox -r "extract vendor and total as csv" -o ./out   # automation
+```
+
+```python
+from inklight import DocumentAgent
+
+agent = DocumentAgent()
+result = agent.ask("Extract the invoice number, date, and total", files=["invoice.pdf"])
+
+print(result.answer)        # human-readable answer
+print(result.table())       # [{'document': 'invoice.pdf', 'invoice_number': 'INV-2041', 'date': '2026-10-03', 'total': 5616.0}]
+print(result.sources[0])    # name='invoice.pdf' page=1 bbox=(200.4, 325.0, 667.6, 359.5) excerpt='INVOICE #INV-2041' ocr_conf=1.0
+print(result.warnings, result.confidence, result.trace)
+```
+
+More: typed extraction without natural language (`agent.extract(files, fields=[...])` or `schema=`), `ask_async`,
+library management (`agent.library.search/remove/reindex`), and the HTTP API at `/api/docs` when serving.
+See [docs/API.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/docs/API.md).
+
+## What it can do
+
+| You say | Inklight does | Tools |
+|---|---|---|
+| "create a CSV of vendor, date, tax and total" | Typed extraction with provenance, then writes the CSV (with permission) | `extract_fields → write_output` |
+| "contracts that expire within 90 days" | Extracts expiry dates, filters by date window | `extract_fields → filter_records` |
+| "invoices above $5,000" | Exact numeric filter | `extract_fields → filter_records` |
+| "sum of all invoice totals" | Decimal arithmetic, reports missing values | `extract_fields → calculate` |
+| "compare these reports" | Field and line diffs, changed figures (`6% → 17%`) | `compare_documents` |
+| "flag inconsistent customer names" | Fuzzy grouping of variants, arithmetic and date checks | `extract_fields → find_inconsistencies` |
+| "find the paragraph about termination" | Retrieval, then the exact block with its box on the page | `search → cite` |
+| "what was revenue growth in Q2?" | Field shortcut, extractive reader, or best sentence, with citation | `search → answer` |
+| "summarize the reports" | Extractive summaries with page citations | `summarize` |
+
+## How it works
+
+```
+request ─► planner (typed plan, from your words only) ─► bounded runner ─► tools ─► cited answer + what it understood
+                                                                   │
+            library: SQLite + FTS5 (+ vectors) ◄── ingest ◄── Indra OCR (text layer first, OCR where needed)
+```
+
+Details in [docs/ARCHITECTURE.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/docs/ARCHITECTURE.md). The short version of the "200M-parameter" story:
+we measured a 135M model as a planner and it was right 27.5% of the time, so the small models do what small
+models are good at (pointing at evidence, ranking passages) and deterministic code does the rest.
+
+## Configuration
+
+`~/.inklight/config.toml` (see [config.example.toml](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/config.example.toml)) or environment variables such as
+`INKLIGHT_LIMITS__MAX_PAGES=50`. Brain modes:
+- `rules`: no models.
+- `auto` (default): use the small models if they are installed.
+- `local`: require the small models.
+- `models.remote_*`: optional stronger model behind an OpenAI-compatible API, for low-confidence questions.
+
+## Limits, honestly
+
+- OCR quality is Indra's. It is weaker on handwriting, degraded scans, complex tables and some scripts
+  ([Indra's notes](https://github.com/datalab-to/indra)). Low OCR confidence is surfaced on every value.
+- Field labels are English. Ambiguous dates like `03/04/2026` are read month-first.
+- The rule planner covers common document tasks. Unusual phrasing falls back to question answering,
+  or to a remote model if you configured one.
+- Semantic search scans vectors in memory, which suits libraries up to tens of thousands of chunks.
+
+## ⚠ License notice — read before commercial use
+
+Inklight's code is **Apache-2.0**. The **Indra OCR model weights** (downloaded by `indra-ocr`, not
+bundled) use a **modified OpenRAIL-M license**. It is free for research, personal use, and organisations
+under $20M revenue and under $20M funding. It restricts commercial use that **competes with Datalab**.
+A commercial document-AI product built on Inklight + Indra needs a license from
+[Datalab](https://www.datalab.to/pricing), or a different OCR engine (the OCR layer is pluggable).
+Full audit: [THIRD_PARTY_LICENSES.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/THIRD_PARTY_LICENSES.md).
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                      # 128 tests, about 1 minute on CPU (downloads Indra models on first run)
+ruff check src tests && mypy src
+python bench/run.py         # reproduces docs/BENCHMARKS.md
+```
+
+See [CONTRIBUTING.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/CONTRIBUTING.md), [CHANGELOG.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/CHANGELOG.md), [CODE_OF_CONDUCT.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/CODE_OF_CONDUCT.md)
+and, for maintainers, [docs/PUBLISHING.md](https://github.com/MahmoudYahiaAhmed/inklight/blob/main/docs/PUBLISHING.md).