roascan 2.0.1__tar.gz

roascan-2.0.1/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 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 2026 Roa (RoaScan Project)
+
+   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.

roascan-2.0.1/MANIFEST.in

@@ -0,0 +1,22 @@
+include LICENSE
+include NOTICE
+include THIRD_PARTY_LICENSES.txt
+include README.md
+include SKILL.md
+include mcp_config.json
+include ROASCAN_ROADMAP_2026.md
+include pyproject.toml
+include setup.py
+
+recursive-include roascan *.py *.dll *.so *.dylib
+recursive-include roascan/models *.onnx *.txt *.dic
+recursive-include roascan-native CMakeLists.txt *.md *.cpp *.hpp *.h
+recursive-include dotnet *.cs
+recursive-include examples *.py
+recursive-include tests *.py *.png
+recursive-include tests/assets *.ttf *.txt *.md
+
+prune roascan-native/build
+prune build
+prune dist
+global-exclude __pycache__ *.py[cod] *.tmp *.log

roascan-2.0.1/NOTICE

@@ -0,0 +1,76 @@
+RoaScan (roascan)
+Copyright 2026 Roa (RoaScan Project)
+
+This product includes software developed for the RoaScan project (https://github.com/edisonroaa-code/roascan),
+licensed under the Apache License, Version 2.0 (see `LICENSE`).
+
+================================================================================
+THIRD-PARTY MODELS, LEXICONS, AND RUNTIME DEPENDENCIES PROVENANCE & LICENSES
+================================================================================
+
+1. Neural OCR Recognition Weights & Character Vocabularies (Bundled in `roascan/models/`):
+   - License: Apache License 2.0 (Permissive — PaddlePaddle Contributors)
+   - Upstream Repository: https://github.com/PaddlePaddle/PaddleOCR
+   - Exact Bundled Artifacts, Sizes & SHA-256 Checksums:
+     * `roascan/models/roascan_rec_latin_v5.onnx`
+       - Size: 7,904,513 bytes
+       - SHA-256: `b20bd37c168a570f583afbc8cd7925603890efbcdc000a59e22c269d160b5f5a`
+       - Upstream Model Origin: PaddleOCR Multilingual Latin SVTR/CRNN recognition inference graph
+         (`latin_PP-OCRv3_rec_infer` / PP-OCR Latin recognition architecture).
+     * `roascan/models/roascan_rec_en.onnx`
+       - Size: 8,967,018 bytes
+       - SHA-256: `ef7abd8bd3629ae57ea2c28b425c1bd258a871b93fd2fe7c433946ade9b5d9ea`
+       - Upstream Model Origin: PaddleOCR English SVTR/CRNN recognition inference graph
+         (`en_PP-OCRv4_rec_infer`).
+     * `roascan/models/ppocrv5_latin_dict.txt`
+       - Size: 1,634 bytes
+       - SHA-256: `3c0a8a79b612653c25f765271714f71281e4e955962c153e272b7b8c1d2b13ff`
+       - Upstream Origin: `ppocr/utils/dict/latin_dict.txt` (PaddleOCR Apache-2.0)
+     * `roascan/models/en_dict.txt`
+       - Size: 190 bytes
+       - SHA-256: `5662df9d2d03f0e8ca0d3b0649d6acbab904b6a14b3d3521463c71c37c668ce3`
+       - Upstream Origin: `ppocr/utils/en_dict.txt` (PaddleOCR Apache-2.0)
+   - Reproducible Export Procedure (Paddle Inference -> ONNX Runtime):
+     ```bash
+     pip install paddle2onnx>=1.0.5 onnx>=1.14.0
+     paddle2onnx \
+       --model_dir ./inference_model_dir \
+       --model_filename inference.pdmodel \
+       --params_filename inference.pdiparams \
+       --save_file roascan_rec_model.onnx \
+       --opset_version 11 \
+       --enable_onnx_checker True
+     ```
+
+--------------------------------------------------------------------------------
+
+2. Spanish Orthographic Lexicon (Bundled in `roascan/models/es_ES.dic`):
+   - File: `roascan/models/es_ES.dic`
+   - Size: 715,989 bytes
+   - SHA-256: `6975dddec3d5d2c676069537bc67b4b5f786c65c5d4cf6703a82acf779ac9ec1`
+   - Upstream Source: RLA-ES (Recursos Lingüísticos Abiertos del Español) v2.8
+     (https://github.com/sbosio/rla-es / https://github.com/sbosio/rla-es/blob/master/LICENSE.md)
+   - Original Authors: Santiago Bosio and RLA-ES contributors.
+   - Upstream License Options: Tri-licensed under GPLv3+ / LGPLv3+ / MPL-1.1+.
+   - Elected License for Redistribution in RoaScan: **Mozilla Public License Version 1.1 (MPL-1.1)**.
+     `roascan/models/es_ES.dic` is distributed as an unmodified standalone plain-text dictionary
+     file under the terms of the Mozilla Public License Version 1.1 (see `THIRD_PARTY_LICENSES.txt`).
+     Under MPL-1.1 Section 3.7 ("Larger Works"), the unmodified dictionary file is combined with
+     RoaScan's Apache-2.0 code as a separate data file read at runtime. Source availability for
+     `es_ES.dic` is satisfied both by its direct inclusion in plain text within `roascan/models/es_ES.dic`
+     and at https://github.com/sbosio/rla-es.
+
+--------------------------------------------------------------------------------
+
+3. External Python Runtime Dependencies (Not Bundled in Wheel/sdist; Installed via PyPI):
+   - `onnxruntime` — MIT License (Microsoft Corporation)
+   - `numpy` — BSD-3-Clause License (NumPy Developers)
+   - `Pillow` — MIT-CMU Permissive License (Jeffrey A. Clark & contributors)
+   - `PyMuPDF` (`fitz`) — GNU Affero General Public License v3.0 (AGPL-3.0) or Commercial
+     License from Artifex Software, Inc. (https://pymupdf.readthedocs.io/en/latest/about.html).
+     IMPORTANT COMPLIANCE NOTICE:
+     RoaScan does NOT bundle, copy, or redistribute `PyMuPDF` inside its source repository,
+     `sdist`, or `wheel`. RoaScan's own C++17 and Python code is licensed under Apache-2.0.
+     However, when `PyMuPDF` is installed from PyPI and imported at runtime for PDF ingestion
+     or searchable PDF generation, the resulting runtime environment is subject to `PyMuPDF`'s
+     AGPL-3.0 license terms unless the user holds a commercial license from Artifex Software, Inc.

roascan-2.0.1/PKG-INFO

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: roascan
+Version: 2.0.1
+Summary: RoaScan: Ultra-lightweight C++17 & ONNX multi-page OCR engine and MCP Server for AI Agents (Scanned PDF/TIFF -> Restored Searchable PDF & Structured Markdown).
+Author: Roa
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/edisonroaa-code/roascan
+Project-URL: Repository, https://github.com/edisonroaa-code/roascan
+Project-URL: Issues, https://github.com/edisonroaa-code/roascan/issues
+Keywords: ocr,roascan,mcp,model-context-protocol,ai-agent,pdf-to-markdown,searchable-pdf,document-restoration,onnxruntime,cpp17
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: Microsoft :: Windows :: Windows 10
+Classifier: Operating System :: Microsoft :: Windows :: Windows 11
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: C++
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY_LICENSES.txt
+Requires-Dist: numpy>=1.22.0
+Requires-Dist: Pillow>=9.5.0
+Requires-Dist: onnxruntime>=1.15.0
+Requires-Dist: PyMuPDF>=1.22.0
+Provides-Extra: desktop
+Requires-Dist: pystray>=0.19.0; extra == "desktop"
+Requires-Dist: pynput>=1.7.0; extra == "desktop"
+Requires-Dist: platformdirs>=3.0.0; extra == "desktop"
+Dynamic: license-file
+
+# RoaScan (`roascan`) — C++17 & ONNX Multi-Page OCR + MCP Server for AI Agents
+
+**RoaScan** (`roascan`) is a local, CPU-first multi-page OCR and optical document restoration engine powered by a clean-room **C++17 native core** (`roascan_core`) and **ONNX Runtime** (`PP-OCRv5 Latin` / `PP-OCRv4 English`).
+
+Designed as an **Agent-First local OCR tool** (Antigravity, Claude Code, Claude Desktop, Cursor, Windsurf, OpenHands) and document restoration library that runs on CPU without requiring GPU hardware, Tesseract, or Ghostscript.
+
+---
+
+## Key Capabilities & Architectural Scope
+
+1. **Multi-Page Scanned Input (Lazy Streaming & Disk-Spooling)**:
+   - Native ingestion of multi-page `.pdf` (rasterized page-by-page on demand), `.tiff`/`.tif`, `.png`, `.jpg`, and `.bmp`.
+   - In Markdown/text mode (`set_retain_images(False)`), page bitmaps are discarded immediately after recognition (`0 bytes` retained in `engine._pages`).
+   - In Searchable PDF mode (`set_retain_images(True)`), restored page images are spooled as compressed PNGs to an exclusive temporary directory (`_spool_dir`) and automatically cleaned up on `engine.close()`, keeping **`0 bytes` of raw uncompressed bitmaps in `engine._pages` RAM**.
+2. **Dual High-Value Output**:
+   - **Restored Searchable PDF (`.pdf`)**: Preserves physical page dimensions in PDF points (`72 pt/inch`, e.g. `595.28 x 841.89 pt` for A4) and document-level metadata (`title`, `author`), applies C++17 Sauvola 64-bit integral background whitening, 1px anti-aliased ink preservation, coarse-to-fine deskew (`0.1°` precision), and orthogonal `90° / 180° / 270°` orientation recovery with an invisible selectable text overlay (`Ctrl+F`).
+   - **Structured Semantic Markdown (`.md`)**: Automatic reconstruction of `#`/`##` titles via typographic font-height clustering, `**Key:** Value` pairs, multi-column reading order (`XY-Cut`), C++ morphological table grid-line removal, and GitHub-Flavored Markdown tables (`|---|---|`).
+3. **Built-in Model Context Protocol (MCP) Server**: Ready-to-run stdio JSON-RPC 2.0 server (`roascan --mcp` or `roascan-mcp`) exposing 4 validated tools (`roascan_to_markdown`, `roascan_to_searchable_pdf`, `roascan_process_document`, `roascan_inspect_pdf`).
+4. **Spanish & Latin Diacritic Restoration**: Built-in Hunspell lexicon with `/G` and `/S` affix expansion (`ELECTRONICA` -> `ELECTRÓNICA`, `REPUBLICA` -> `REPÚBLICA`, `Pena` -> `Peña`).
+
+> [!IMPORTANT]
+> **Scope of Optical PDF Restoration (`roascan_to_searchable_pdf` / `--pdf`):**
+> The Searchable PDF pipeline is an **optical scan restorer**. It rasterizes each page, corrects orthogonal rotations (`90°/180°/270°`) and fine skew, whitens shadowed backgrounds, and reconstructs the page from the restored bitmap at exact physical dimensions (`72 pt/inch`) with an invisible selectable text layer (`render_mode=3`) and document metadata (`title`, `author`). Native vector objects, interactive hyperlinks, annotations, and AcroForm fields from digital-born PDFs are not preserved.
+
+---
+
+## Measured Footprint & Reproducible Performance
+
+| Metric | Measured Value (Intel Core i7-7700 4C/8T, Windows x64, Python 3.12) |
+| :--- | :--- |
+| **RoaScan Wheel Artifact Size** | `~15.0 MiB` compressed (`~17.0 MiB` unpacked, including C++ DLL + ONNX weights + Hunspell lexicon) |
+| **Full Runtime Environment** | `~223 MiB` on disk when including `onnxruntime`, `numpy`, `Pillow`, and `PyMuPDF` in a clean virtual environment |
+| **C++17 Coarse-to-Fine Deskew Kernel** | `~0.90–1.96 ms` (median `~1.03 ms`) on synthetic 300 DPI A4 binary page (`-15°..+15°` at `0.1°` step with spatial subsampling) |
+| **End-to-End Single-Page OCR** | `~230–720 ms` in-process (`ocr_elapsed_ms` after ONNX session init; `~1.1 s` total cold CLI invocation including interpreter & session startup) |
+| **30-Page A4 PDF Memory Profile** | `0 bytes` of raw page bitmaps retained in `engine.extract_pages()` in both Markdown and Searchable PDF modes |
+
+### Platform Verification Status
+- **Windows x64 (`win_amd64`)**: Precompiled `roascan_core.dll` bundled in wheel (`py3-none-win_amd64`); verified end-to-end. Requires standard Microsoft Visual C++ Redistributable (`MSVCP140.dll` / `VCRUNTIME140.dll`).
+- **Linux & macOS (Experimental Source Build)**: Native compilation, functional OCR, MCP, and wheel builds pass GitHub Actions on both platforms. Desktop integration remains unverified there. `sdist` includes full C++17 sources and `CMakeLists.txt` (`roascan-native/`). Building a wheel from source (`pip install .` or `python -m build --wheel`) automatically invokes `cmake` via `setup.py` to compile `libroascan_core.so` / `libroascan_core.dylib` (requires `cmake >= 3.16` and a C++17 compiler).
+
+---
+
+## Repository Structure
+
+```text
+├── pyproject.toml             # PEP 621 package definition
+├── setup.py                   # CMake native builder & platform-tagged wheel packager
+├── MANIFEST.in                # Complete source distribution (sdist) manifest
+├── LICENSE                    # Full Apache-2.0 License
+├── NOTICE                     # Provenance, SHA-256 hashes, and licensing notices
+├── THIRD_PARTY_LICENSES.txt   # Full license texts for bundled third-party resources (MPL-1.1 / Apache-2.0)
+├── SKILL.md                   # AI Agent discovery & usage specification
+├── mcp_config.json            # Ready-to-use Model Context Protocol (MCP) config
+├── roascan/                   # Python SDK, CLI, MCP Server, bundled DLL & ONNX models
+│   ├── api.py                 # Stable high-level API & Bridge Contract (`run_ocr`, `RoaScanResult`)
+│   └── desktop/               # Desktop capture, interactive region crop & native clipboard
+├── roascan-native/            # C++17 Native Core (`roascan_core`) & CMake build
+├── dotnet/                    # Experimental C# / .NET P/Invoke preprocessing bridge (`RoaScan.cs`)
+├── examples/                  # End-to-end Python usage examples
+└── tests/                     # Automated pytest suite (`test_functional_ocr.py`, `test_desktop_and_api.py`)
+```
+
+---
+
+## Installation (`pip install`)
+
+```bash
+# 1. Core library + CLI + MCP Server:
+pip install roascan
+
+# 2. With desktop tray companion & global shortcut extra:
+pip install "roascan[desktop]"
+
+# Verify installation, native C++ core, and ONNX models:
+roascan --doctor
+```
+
+---
+
+## 1. Python API (`roascan.run_ocr`)
+
+Stable bridge contract supporting file paths, PIL images, or raw image bytes without network dependencies:
+
+```python
+import roascan
+
+# Run local OCR with automatic language correction & Markdown reconstruction
+result = roascan.run_ocr("factura.png", language="es")
+
+# Standard bridge contract attributes:
+print(result.text)          # Reconstructed plain text
+print(result.markdown)      # Structured Markdown with tables & headings
+print(len(result.words))    # Detected words with bboxes & confidences
+print(result.confidences)   # List of word confidence scores
+
+# Copy recognized text directly to the Windows clipboard:
+result.copy_to_clipboard()
+
+# Save structured Markdown:
+result.save_markdown("factura.md")
+
+# Access as dictionary mapping:
+data = result.to_dict()
+```
+
+---
+
+## 2. CLI Usage (`roascan`)
+
+```bash
+# 1. OCR a file and copy text directly to clipboard:
+roascan ocr factura.png --out factura.md --copy
+
+# 2. Interactive desktop region capture (Tkinter overlay -> OCR -> clipboard):
+roascan clip
+
+# 3. Capture specific coordinates without interactive prompt:
+roascan clip --bbox 100,100,700,500 --out recorte.md
+
+# 4. Convert a scanned multi-page PDF into both Searchable PDF and Markdown:
+roascan scan.pdf --pdf limpio.pdf --md out.md --lang es
+
+# 5. Output unified, versioned JSON (includes ocr_elapsed_ms and total elapsed_ms):
+roascan factura.pdf --json
+
+# 6. Run environment & model health check:
+roascan --doctor
+```
+
+---
+
+## 3. Desktop Screen Capture & Tray Companion (`roascan.desktop`)
+
+RoaScan includes an offline desktop companion (clean-room design: zero cloud, zero accounts, zero telemetry):
+
+### 3.1. System Tray Companion (`roascan tray` / `roascan-tray`)
+Starts a lightweight background companion in the Windows notification area with a global shortcut:
+- **Default Global Shortcut:** `Ctrl+Shift+O` (triggers interactive region crop -> OCR -> copies text to clipboard).
+- **Tray Menu:** "OCR región" (triggers capture), "Salir" (clean shutdown).
+- **Anti-Reentrancy Lock:** Prevents overlapping captures if the shortcut is pressed repeatedly.
+
+```bash
+# Launch background system tray companion (default hotkey Ctrl+Shift+O):
+roascan tray
+# or
+roascan-tray
+# or
+python -m roascan.desktop
+
+# Custom hotkey or tray-only mode:
+roascan tray --hotkey "Ctrl+Alt+O"
+roascan tray --no-hotkey  # tray menu only
+roascan tray --ui-lang en # English interface
+```
+
+> **Windows Hotkey Note:** Global shortcuts registered via `pynput` run in normal user mode and do not require administrative privileges. However, when an elevated administrator window (UAC) has active focus, Windows restricts non-elevated global keyhooks. To change the shortcut permanently without CLI flags, use `roascan config set hotkey "Ctrl+Alt+O"` or set `ROASCAN_HOTKEY="Ctrl+Alt+O"`.
+
+### 3.2. Result Inspection & Editing Panel (P5)
+
+When a region or clip is recognized, RoaScan automatically opens a lightweight, non-blocking result window:
+- **Editable Text Area**: Review, edit, or format the recognized text before saving or copying.
+- **Copy**: Places the *currently edited* text onto the system clipboard.
+- **Save**: Exports the text as structured Markdown (`.md`) or plain text (`.txt`) to the configured `save_dir` (default: `~/Documents/RoaScan`).
+- **Close / Escape**: Dismisses the panel cleanly while keeping the background tray companion alive.
+- **Single Instance**: Triggering another OCR updates the active panel and brings it to the front rather than stacking multiple windows.
+
+```bash
+# Open interactive result panel directly from CLI clip:
+roascan clip --panel
+```
+
+### 3.3. User Preferences & Localization (P6)
+
+RoaScan stores user preferences in standard platform directories (`%LOCALAPPDATA%/roascan/config.json` on Windows or `~/.config/roascan/config.json` on Linux/macOS via `platformdirs`).
+
+#### CLI Configuration Management:
+```bash
+# View active configuration and defaults:
+roascan config show
+
+# Get the path to config.json:
+roascan config path
+
+# Change preferences:
+roascan config set hotkey "Ctrl+Shift+O"
+roascan config set ui_lang "en"         # "es" or "en"
+roascan config set ocr_lang "es"        # "es", "en", "latin"
+roascan config set show_result_panel true
+roascan config set copy_on_success true
+roascan config set save_dir "D:/MisDocumentos/OCR"
+```
+
+#### Precedence Order:
+`CLI Flags > Environment Variables (e.g. ROASCAN_HOTKEY, ROASCAN_UI_LANG) > config.json > Default Values`.
+
+### 3.4. Programmatic Desktop Capture, Panel & Clipboard API
+
+```python
+from roascan.desktop import (
+    capture_region_and_ocr,
+    show_result_panel,
+    copy_to_clipboard,
+    get_clipboard_text,
+    load_config,
+)
+
+# 1. Capture screen region -> local OCR -> show result editor:
+result = capture_region_and_ocr(interactive=True, copy_clipboard=True, language="es")
+if result and result.text:
+    show_result_panel(result.text, blocking=True)
+
+# 2. Read or write native Windows clipboard without external dependencies:
+copy_to_clipboard("Texto copiado desde RoaScan")
+print("Clipboard actual:", get_clipboard_text())
+```
+
+---
+
+## 4. Model Context Protocol (MCP) Server
+
+Start the MCP server over `stdio`:
+
+```bash
+roascan --mcp
+# or
+roascan-mcp
+```
+
+### Claude Desktop / Cursor / Antigravity `mcp_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "roascan": {
+      "command": "roascan-mcp",
+      "args": [],
+      "env": {
+        "PYTHONIOENCODING": "utf-8"
+      }
+    }
+  }
+}
+```
+
+---
+
+## 3. Licensing & Third-Party Notices
+
+- **RoaScan Source Code (C++17 & Python)**: Licensed under the **Apache License 2.0** (see [`LICENSE`](https://github.com/edisonroaa-code/roascan/blob/main/LICENSE)).
+- **Bundled Neural Models (`roascan/models/*.onnx`, `*_dict.txt`)**: Derived from PaddleOCR under **Apache License 2.0**. Exact bundled SHA-256 checksums and an example `paddle2onnx` export command are documented in [`NOTICE`](https://github.com/edisonroaa-code/roascan/blob/main/NOTICE).
+- **Bundled Spanish Orthographic Dictionary (`roascan/models/es_ES.dic`)**: Unmodified plain-text dictionary from RLA-ES v2.8, distributed under the elected **Mozilla Public License Version 1.1 (`MPL-1.1`)** option (see [`NOTICE`](https://github.com/edisonroaa-code/roascan/blob/main/NOTICE) and [`THIRD_PARTY_LICENSES.txt`](https://github.com/edisonroaa-code/roascan/blob/main/THIRD_PARTY_LICENSES.txt)).
+- **Runtime Dependency `PyMuPDF` (`fitz`)**: Not bundled or redistributed in RoaScan packages; installed from PyPI at runtime under **AGPL-3.0** (or commercial license from Artifex Software, Inc.). See [`NOTICE`](https://github.com/edisonroaa-code/roascan/blob/main/NOTICE) for compliance details.