docslight 0.1.0__py3-none-any.whl

docslight-0.1.0.dist-info/METADATA

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: docslight
+Version: 0.1.0
+Summary: Lightweight ComPDF document parsing and extraction SDK
+Author-email: ComPDF AI <support@compdf.com>
+License-Expression: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: typing-extensions>=4.8.0; python_version < "3.11"
+Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+Requires-Dist: flask>=3.1.3
+Requires-Dist: werkzeug>=3.1.8
+Provides-Extra: local
+Requires-Dist: Pillow>=10.0.0; extra == "local"
+Requires-Dist: PyMuPDF>=1.23.0; extra == "local"
+Requires-Dist: numpy>=1.24.0; extra == "local"
+Requires-Dist: paddlepaddle>=3.3.0; extra == "local"
+Requires-Dist: paddleocr[doc-parser]>=3.3.0; extra == "local"
+Requires-Dist: python-docx>=1.1.0; extra == "local"
+Requires-Dist: python-pptx>=0.6.23; extra == "local"
+Requires-Dist: openpyxl>=3.1.0; extra == "local"
+Provides-Extra: local-llm
+Requires-Dist: openai>=1.0.0; extra == "local-llm"
+Provides-Extra: web
+Requires-Dist: Flask>=3.0.0; extra == "web"
+Requires-Dist: Werkzeug>=3.0.0; extra == "web"
+Provides-Extra: web-test
+Requires-Dist: playwright>=1.40.0; extra == "web-test"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.7.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Requires-Dist: Pillow>=10.0.0; extra == "dev"
+Requires-Dist: PyMuPDF>=1.23.0; extra == "dev"
+Requires-Dist: numpy>=1.24.0; extra == "dev"
+Requires-Dist: python-docx>=1.1.0; extra == "dev"
+Requires-Dist: python-pptx>=0.6.23; extra == "dev"
+Requires-Dist: openpyxl>=3.1.0; extra == "dev"
+Requires-Dist: Flask>=3.0.0; extra == "dev"
+Requires-Dist: Werkzeug>=3.0.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <h1 align="center">DocSlight</h1>
+  <p align="center">Lightweight Python SDK & CLI for document parsing and structured extraction</p>
+  <p align="center">
+    <a href="https://pypi.org/project/docslight/"><img src="https://img.shields.io/pypi/v/docslight" alt="PyPI"></a>
+    <a href="https://pypi.org/project/docslight/"><img src="https://img.shields.io/pypi/pyversions/docslight" alt="Python versions"></a>
+    <a href="LICENSE"><img src="https://img.shields.io/github/license/kdanmobile/docslight" alt="License"></a>
+  </p>
+</p>
+
+## What is DocSlight?
+
+A lightweight Python library that turns PDFs, images, and Office documents into clean Markdown or structured JSON — with one line of code. Works with ComPDF Cloud (recommended) or fully offline with local parsers.
+
+```python
+from docslight import DocSlight
+
+client = DocSlight(api_key="your-api-key")
+result = client.parse("invoice.pdf")
+print(result.to_markdown())
+```
+
+## Quick Start
+
+```bash
+pip install docslight
+```
+
+Parse any document:
+
+```bash
+docslight parse invoice.pdf --output invoice.md
+```
+
+Extract specific fields:
+
+```bash
+docslight extract invoice.pdf --fields invoice_number,total_amount
+```
+
+Launch the local Web UI workbench:
+
+```bash
+pip install "docslight[web]"
+docslight web
+# Open http://127.0.0.1:8000
+
+# Or run the same Web UI directly as a module
+python -m docslight.web_app --host 0.0.0.0 --port 8000 --debug
+```
+
+## Features
+
+- **Dual mode** — ComPDF Cloud for production-grade results, or local CPU parsing for offline evaluation
+- **Parse → Markdown** — Convert PDF, DOCX, PPTX, XLSX, and images (PNG, JPG, TIFF, BMP, WebP) to clean Markdown
+- **Extract → JSON** — Pull structured data by field list, JSON Schema, or structured template (key-value + table extraction)
+- **CLI first** — Full-featured command-line interface, script-friendly
+- **Web UI** — Local Flask workbench with drag-and-drop, live preview with bbox highlights, and a Fields Builder UI
+- **Batch processing** — `parse_batch()` / `extract_batch()` for multiple files
+- **Local LLM extraction** — Ollama or any OpenAI-compatible provider for offline extraction
+- **Document types** — Classify and route documents by type for cloud extraction
+- **Error-safe** — Typed result objects, structured error hierarchy, no credential leaks
+
+## Install
+
+| Scenario | Command |
+|----------|---------|
+| Core SDK & CLI | `pip install docslight` |
+| + Local parsing (OCR, Office) | `pip install "docslight[local]"` |
+| + Local LLM extraction | `pip install "docslight[local,local-llm]"` |
+| + Web UI workbench | `pip install "docslight[web]"` |
+
+> Local CPU parsing is experimental. Validate accuracy and latency on your own documents before production use.
+
+## SDK Usage
+
+### Cloud — Parse
+
+```python
+from docslight import DocSlight
+
+client = DocSlight(mode="cloud", api_key="your-api-key")
+
+result = client.parse("invoice.pdf")
+print(result.to_markdown())   # Clean markdown
+print(result.to_json())       # Full result with pages + metadata
+```
+
+### Cloud — Extract
+
+```python
+result = client.extract(
+    "invoice.pdf",
+    fields=["invoice_number", "invoice_date", "total_amount"],
+)
+print(result.to_json())
+```
+
+With a JSON Schema:
+
+```python
+schema = {
+    "type": "object",
+    "properties": {
+        "invoice_number": {"type": "string"},
+        "total_amount": {"type": "number"},
+    },
+    "required": ["invoice_number"],
+}
+result = client.extract("invoice.pdf", schema=schema)
+```
+
+With document type classification:
+
+```python
+result = client.extract(
+    "invoice.pdf",
+    fields=["invoice_number"],
+    document_types=["invoice"],
+)
+```
+
+### Local — Parse (Offline)
+
+```python
+client = DocSlight(mode="local")
+result = client.parse("invoice.pdf")
+print(result.to_markdown())
+```
+
+### Local — Extract with Ollama
+
+```python
+client = DocSlight(
+    mode="local",
+    local_llm={"provider": "ollama", "model": "llama3.1"},
+)
+result = client.extract(
+    "invoice.pdf",
+    fields=["invoice_number", "invoice_date"],
+)
+```
+
+### Local — Extract with OpenAI-Compatible API
+
+```python
+client = DocSlight(
+    mode="local",
+    local_llm={
+        "provider": "openai-compatible",
+        "base_url": "https://your-endpoint/v1",
+        "model": "your-model",
+        "api_key": "your-api-key",
+        "extra_body": {"enable_thinking": False},  # e.g., DashScope qwen3
+    },
+)
+```
+
+### Batch Processing
+
+```python
+results = client.parse_batch(["doc1.pdf", "doc2.pdf", "doc3.pdf"])
+for r in results:
+    print(r.to_markdown()[:200])
+```
+
+## CLI Usage
+
+```bash
+# Parse
+docslight parse invoice.pdf --mode cloud -o invoice.md
+docslight parse invoice.pdf --mode local -o invoice.md
+
+# Extract
+docslight extract invoice.pdf --mode cloud --fields invoice_number,total_amount
+docslight extract invoice.pdf --mode local --fields invoice_number --local-llm-provider ollama --local-llm-model llama3.1
+
+# Extract with schema
+docslight extract invoice.pdf --schema schema.json
+
+# Web UI
+docslight web --host 127.0.0.1 --port 8000
+```
+
+## Web UI Workbench
+
+DocSlight Workbench is a local Flask app for visual document processing.
+
+```bash
+pip install "docslight[web]"
+docslight web
+python -m docslight.web_app
+```
+
+- **Parse & Extract tabs** — Switch between parsing and extraction workflows
+- **Drag-and-drop upload** — PDF, images, DOCX, PPTX, XLSX
+- **Live preview** — PDF page rendering with bbox highlight overlays
+- **Fields Builder** — Structured UI for building key-value and table extraction templates
+- **Download results** — One-click download of Markdown or JSON output
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `DOCSLIGHT_API_KEY` | API key for cloud mode |
+| `DOCSLIGHT_MODE` | Processing mode: `cloud` or `local` (default: `cloud`) |
+
+## Supported Inputs
+
+| Mode | Formats |
+|------|---------|
+| Cloud | PDF, images (PNG/JPG/TIFF/BMP/WebP), DOCX, PPTX, XLSX, and more via ComPDF Cloud API |
+| Local | PDF, images (PNG/JPG/TIFF/BMP/WebP), DOCX, PPTX, XLSX |
+
+> Legacy Office formats (`.doc`, `.ppt`, `.xls`) must be converted to DOCX/PPTX/XLSX for local processing.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+ruff check .
+mypy docslight
+pytest
+python -m build
+```
+
+## License
+
+MIT License. See `LICENSE`.

docslight-0.1.0.dist-info/RECORD

@@ -0,0 +1,39 @@
+docslight/__init__.py,sha256=OCbA3TldIR0aIKDzpGi96iRAuexkQrjnPMIvS8DTZiI,957
+docslight/cli.py,sha256=ozpMtFpmkS6CSbiTdrkOJlj7TVuc4Tj34tvtE80mSWE,7459
+docslight/client.py,sha256=Yfa4MqAe8wTJjJw6LI00KL10UdnB6Igblm1eLtl45UM,3534
+docslight/config.py,sha256=BAuRkKuVZVnki-LvBYIeKAU30FrOoqns3bPq0vpVmnQ,3807
+docslight/exceptions.py,sha256=sFk-EP_Oe-0AR1b1YlZLekt7miTIcRO8y29XywxuMQg,1703
+docslight/preview.py,sha256=lqpPbcLoxKJx1M7FeO86Agw0GBUCBPa3p9iWdq6Nk9g,1788
+docslight/result.py,sha256=C4Hry53cVAKXIij0Yv-GX6wQUfEPnfGxmsnHb5qd2s8,2987
+docslight/standard_json.py,sha256=xiKOAxtbDybiFg5LLOKLrFrkCH9lLtfEO8CsJV4fh6c,12528
+docslight/web_app.py,sha256=OkDPKZuHNe52A3wyk_NWjPjL2FPxqaC9DfLgZ4wp7Xg,13518
+docslight/cloud/__init__.py,sha256=Hk2-B1809THMXRTm9QUj8Q2y2J40cTIeYGx0yKlXz7s,123
+docslight/cloud/client.py,sha256=9xy-9XUpUGHZmFHKrcZ4rP3AC_PfdXtfQzqfRCpE24k,22517
+docslight/local/__init__.py,sha256=cOlFSTlE_4NJDvxFydjukFTb5dh03WtZdmgEj-I0l4w,809
+docslight/local/layout_blocks.py,sha256=TPBS4WqjWGe625Mxq4SwVDakOfuJLQsXwit9yB4T5oc,2975
+docslight/local/llm_extractor.py,sha256=yGxqWGtc-fo1xXMoSAhc7oWKWJoc3vFf1YP0Yk8MzLw,8703
+docslight/local/loaders.py,sha256=hK2apRUeG6U5FNIezwRRDOpPXNeWEbfQt2FG24plP9k,3275
+docslight/local/markdown.py,sha256=nH4vN1qk7y7RUxUk2qD1PRMMZRaJhm0y13bN-Q6iLi8,626
+docslight/local/office_loader.py,sha256=JmrX3ne1eT0GGLDBRp6MdYAf4scL4ybUODFcSAYZ4V4,5382
+docslight/local/paddle_parser.py,sha256=-707LgB9ih6Uieu7D6Cr0tXkNG1f5PMNNqS3YSPbYYo,6454
+docslight/local/pipeline.py,sha256=actIKjfaJ3AykymrmzgBkFYIuqJTnOHGzK3bbZPrqvM,8668
+docslight/providers/__init__.py,sha256=WavbBqBDcGs65B0tZqTG7u1sEkoWbqmoolPREJlIytI,254
+docslight/providers/ollama.py,sha256=7zEeuGhsQrU4jo7O0b4JSR3pdQHZU21GJIGwXaqe628,843
+docslight/providers/openai_compatible.py,sha256=y9DR_yL2rLBqv1cManzahYNb74SaskMXRhGHHl2iQM8,2275
+docslight/schemas/__init__.py,sha256=-HJLylY01HoX6HV4wP2llZ_moXUtjW92_CQwuxLB6Q0,191
+docslight/schemas/fields.py,sha256=vhC3LpbRt0CpGz49YzT6NnV0sAQ_Zx9KYCq4zUmWNQY,7094
+docslight/static/styles.css,sha256=woDz4dUYQLl4sgfGjVwxvfLUpaskv3Kla9bBnGkzuWg,16287
+docslight/static/app/common.js,sha256=ooBbE7NQOzgzLA4Ef4KsKH9XB9nwiNbLPm1Y1UtVG2o,23697
+docslight/static/app/docslight-extract.json,sha256=J8Dv2XIkeh_283pklNVP8izc5gN9xKB7-z5PUR7kaiY,6282
+docslight/static/app/extract.js,sha256=dh5_Pi7Ll1t1rPo9vgyPa_AVl4b9ttJOFzFE_m0ysls,14495
+docslight/static/app/i18n.js,sha256=cFv7oZlTpxjs57ad_JZC61xqakhzrJbKfAL-W7wENkU,17775
+docslight/static/app/parse.js,sha256=qFk3iCouHWR51afjJS94cE45yMt1U_XPVBInfYFO1eg,5441
+docslight/templates/base.html,sha256=sXpWTxP_uvp1aCmyt52RIetPHNuaxYy1TnVN_ONSB_c,1694
+docslight/templates/extract.html,sha256=LMl_xuxnTXbqSO7RMJswEVDe1zLBXR1AxyD0PxqoLOk,6277
+docslight/templates/parse.html,sha256=Sm5b2GsovJUPq2eWTiesj04phXKFVrkJVKHtFT7NQ5Q,4130
+docslight-0.1.0.dist-info/licenses/LICENSE,sha256=C5PGcCZEjsiOF7rAof4gU_VahlwqfLIUeL7eHnDZT34,1087
+docslight-0.1.0.dist-info/METADATA,sha256=ZTCWvDRt-AcDWbGqhuviFTZWpT3nHfP8rWvM2wDRRVY,8449
+docslight-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+docslight-0.1.0.dist-info/entry_points.txt,sha256=ekw6ynMNLGFXp0K-r1XUDLcS6BN2nzoAVzCUDEHFu8c,49
+docslight-0.1.0.dist-info/top_level.txt,sha256=_u4jxf9wMEplc-nj0eJOYLTH6x3sFogHbbBcTn45SFA,10
+docslight-0.1.0.dist-info/RECORD,,

docslight-0.1.0.dist-info/WHEEL

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

docslight-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+docslight = docslight.cli:main

docslight-0.1.0.dist-info/licenses/LICENSE

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

docslight-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+docslight