exstruct 0.1.0__py3-none-any.whl

exstruct-0.1.0.dist-info/METADATA

@@ -0,0 +1,154 @@
+Metadata-Version: 2.3
+Name: exstruct
+Version: 0.1.0
+Summary: Add your description here
+Keywords: excel,structure,data,exstruct
+Author: harumiWeb
+Author-email: harumiWeb <ganaharumi@outlook.jp>
+License: BSD 3-Clause License
+         
+         Copyright (c) 2025, ExStruct Contributors
+         All rights reserved.
+         
+         Redistribution and use in source and binary forms, with or without
+         modification, are permitted provided that the following conditions are met:
+         
+         1. Redistributions of source code must retain the above copyright notice, this
+            list of conditions and the following disclaimer.
+         
+         2. Redistributions in binary form must reproduce the above copyright notice,
+            this list of conditions and the following disclaimer in the documentation
+            and/or other materials provided with the distribution.
+         
+         3. Neither the name of the copyright holder nor the names of its
+            contributors may be used to endorse or promote products derived from
+            this software without specific prior written permission.
+         
+         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+         FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+         CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Requires-Dist: numpy>=2.3.5
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: scipy>=1.16.3
+Requires-Dist: xlwings>=0.33.16
+Requires-Dist: pypdfium2>=5.1.0 ; extra == 'render'
+Requires-Dist: python-toon>=0.1.3 ; extra == 'toon'
+Requires-Dist: pyyaml>=6.0.3 ; extra == 'yaml'
+Requires-Python: >=3.12
+Project-URL: Documentation, https://harumiweb.github.io/exstruct/
+Project-URL: Homepage, https://harumiweb.github.io/exstruct/
+Project-URL: Issues, https://github.com/harumiWeb/exstruct/issues
+Project-URL: Repository, https://github.com/harumiWeb/exstruct
+Provides-Extra: render
+Provides-Extra: toon
+Provides-Extra: yaml
+Description-Content-Type: text/markdown
+
+# ExStruct — Excel Structured Extraction Engine
+
+ExStruct reads Excel workbooks and outputs structured data (tables, shapes, charts) as JSON by default, with optional YAML/TOON formats. It targets both COM/Excel environments (rich extraction) and non-COM environments (cells + table candidates), with tunable detection heuristics and multiple output modes to fit LLM/RAG pipelines.
+
+## Features
+
+- **Excel → Structured JSON**: cells, shapes, charts, and table candidates per sheet.
+- **Output modes**: `light` (cells + table candidates only), `standard` (texted shapes + arrows, charts), `verbose` (all shapes with width/height).
+- **Formats**: JSON (compact by default, `--pretty` available), YAML, TOON (optional dependencies).
+- **Table detection tuning**: adjust heuristics at runtime via API.
+- **CLI rendering** (Excel required): optional PDF and per-sheet PNGs.
+- **Graceful fallback**: if Excel COM is unavailable, extraction falls back to cells + table candidates without crashing.
+
+## Installation
+
+```bash
+pip install exstruct
+```
+
+Optional extras:
+
+- YAML: `pip install pyyaml`
+- TOON: `pip install python-toon`
+- Rendering (PDF/PNG): Excel + `pip install pypdfium2`
+
+## Quick Start (CLI)
+
+```bash
+exstruct input.xlsx                # compact JSON (default)
+exstruct input.xlsx --pretty       # pretty-printed JSON
+exstruct input.xlsx --format yaml  # YAML (needs pyyaml)
+exstruct input.xlsx --format toon  # TOON (needs python-toon)
+exstruct input.xlsx --mode light   # cells + table candidates only
+exstruct input.xlsx --pdf --image  # PDF and PNGs (Excel required)
+```
+
+## Quick Start (Python)
+
+```python
+from pathlib import Path
+from exstruct import extract, export, set_table_detection_params
+
+# Tune table detection (optional)
+set_table_detection_params(table_score_threshold=0.3, density_min=0.04)
+
+# Extract with modes: "light", "standard", "verbose"
+wb = extract("input.xlsx", mode="standard")
+export(wb, Path("out.json"), pretty=False)  # compact JSON
+```
+
+## Table Detection Tuning
+
+```python
+from exstruct import set_table_detection_params
+
+set_table_detection_params(
+    table_score_threshold=0.35,  # increase to be stricter
+    density_min=0.05,
+    coverage_min=0.2,
+    min_nonempty_cells=3,
+)
+```
+
+Use higher thresholds to reduce false positives; lower them if true tables are missed.
+
+## Output Modes
+
+- **light**: cells + table candidates (no COM needed).
+- **standard**: texted shapes + arrows, charts (COM if available), table candidates.
+- **verbose**: all shapes (with width/height), charts, table candidates.
+
+## Error Handling / Fallbacks
+
+- Excel COM unavailable → falls back to cells + table candidates; shapes/charts empty.
+- Shape extraction failure → logs warning, still returns cells + table candidates.
+- CLI prints errors to stdout/stderr and returns non-zero on failures.
+
+## Optional Rendering
+
+Requires Excel and `pypdfium2`.
+
+```bash
+exstruct input.xlsx --pdf --image --dpi 144
+```
+
+Creates `<output>.pdf` and `<output>_images/` PNGs per sheet.
+
+## Notes
+
+- Default JSON is compact to reduce tokens; use `--pretty` or `pretty=True` when readability matters.
+- Field `table_candidates` replaces `tables`; adjust downstream consumers accordingly.
+
+## License
+
+BSD-3-Clause. See `LICENSE` for details.
+
+## Documentation
+
+- API Reference (GitHub Pages): https://harumiweb.github.io/exstruct/

exstruct-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+exstruct/__init__.py,sha256=b0100911928de2773b7fb864f6c6402b088f2166b653044c42595a4eb4f8169b,3763
+exstruct/cli/main.py,sha256=7eba1e3b609fd8b547ddbb8cdadc7210d710a7a0c9d86ba0a87269a896bd1672,2321
+exstruct/core/__init__.py,sha256=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855,0
+exstruct/core/cells.py,sha256=3f0b0ce316c861233f2384efe3891b3558f355e35a31c03f806392e1f143fbe7,32366
+exstruct/core/charts.py,sha256=1b8a619c05d5d42bcc68885e5b9a776f181965d9ad5032e1f2d7557ba755c568,7352
+exstruct/core/integrate.py,sha256=b27a100a4a2000374b00c4ce68db3df15ef8e4572e92c250c315db07ae699701,4252
+exstruct/core/shapes.py,sha256=764ae644055dd959552fb695ed83101175b24bff4048d010850c2334e57814a2,8177
+exstruct/io/__init__.py,sha256=1b8aa9f7734ecf8d2711efd1ab5108540b7ae0c4f7459269c1edd8e3c1c22887,5697
+exstruct/models/__init__.py,sha256=8bc805adfdc169fa59a3b6ad7f46c44917755fdc741edfced2148d3f9f70dc2a,1296
+exstruct/models/maps.py,sha256=82a0c2fc2ae79547c3e4f6b33b2fd76b0a40547d27c3bbf1a168968cdc96a787,12943
+exstruct/py.typed,sha256=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855,0
+exstruct/render/__init__.py,sha256=1c80c65aa81176f85d3615f139f24ca705885ce663e0890cefb4344440588d14,2980
+exstruct-0.1.0.dist-info/WHEEL,sha256=b6dc288e80aa2d1b1518ddb3502fd5b53e8fd6cb507ed2a4f932e9e6088b264a,78
+exstruct-0.1.0.dist-info/entry_points.txt,sha256=3429e73dd9d41bb977b49a34914dddd7ec70352b79882bb937a3999e8e8bce9c,53
+exstruct-0.1.0.dist-info/METADATA,sha256=a2d6674d413a613afc73c84ef7319eb86980147ece97f1349b7c7443990e3b6e,6048
+exstruct-0.1.0.dist-info/RECORD,,

exstruct-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.8.4
+Root-Is-Purelib: true
+Tag: py3-none-any

exstruct-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+exstruct = exstruct.cli.main:main
+