PyPI - exstruct - Versions diffs - 0.2.2__tar.gz → 0.2.11__tar.gz - Mend

exstruct 0.2.2tar.gz → 0.2.11tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

{exstruct-0.2.2 → exstruct-0.2.11}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: exstruct
-Version: 0.2.2
+Version: 0.2.11
 Summary: Excel to structured JSON (tables, shapes, charts) for LLM/RAG pipelines
 Keywords: excel,structure,data,exstruct
 Author: harumiWeb
@@ -56,16 +56,16 @@ Description-Content-Type: text/markdown
 # ExStruct — Excel Structured Extraction Engine
-[![PyPI version](https://badge.fury.io/py/exstruct.svg)](https://pypi.org/project/exstruct/) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/exstruct?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/exstruct) ![Licence: BSD-3-Clause](https://img.shields.io/badge/license-BSD--3--Clause-blue?style=flat-square) [![pytest](https://github.com/harumiWeb/exstruct/actions/workflows/pytest.yml/badge.svg)](https://github.com/harumiWeb/exstruct/actions/workflows/pytest.yml)
+[![PyPI version](https://badge.fury.io/py/exstruct.svg)](https://pypi.org/project/exstruct/) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/exstruct?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/exstruct) ![Licence: BSD-3-Clause](https://img.shields.io/badge/license-BSD--3--Clause-blue?style=flat-square) [![CI](https://github.com/harumiWeb/exstruct/actions/workflows/ci.yml/badge.svg)](https://github.com/harumiWeb/exstruct/actions/workflows/ci.yml)
 ![ExStruct Image](/docs/assets/icon.webp)
-ExStruct reads Excel workbooks and outputs structured data (tables, shapes, charts, hyperlinks) 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.
+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). Verbose also emits cell hyperlinks.
+- **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.
@@ -77,17 +77,17 @@ ExStruct reads Excel workbooks and outputs structured data (tables, shapes, char
 pip install exstruct
 ```
-Optional extras:
-- YAML: `pip install pyyaml`
-- TOON: `pip install python-toon`
-- Rendering (PDF/PNG): Excel + `pip install pypdfium2 pillow`
-- All extras at once: `pip install exstruct[yaml,toon,render]`
-Platform note:
-- Full extraction (shapes/charts) targets Windows + Excel (COM via xlwings). On other platforms, use `mode=light` to get cells + `table_candidates` safely.
-## Quick Start (CLI)
+Optional extras:
+- YAML: `pip install pyyaml`
+- TOON: `pip install python-toon`
+- Rendering (PDF/PNG): Excel + `pip install pypdfium2 pillow`
+- All extras at once: `pip install exstruct[yaml,toon,render]`
+Platform note:
+- Full extraction (shapes/charts) targets Windows + Excel (COM via xlwings). On other platforms, use `mode=light` to get cells + `table_candidates` safely.
+## Quick Start (CLI)
 ```bash
 exstruct input.xlsx > output.json          # compact JSON to stdout (default)
@@ -120,19 +120,15 @@ wb.save("out.json", pretty=True)     # WorkbookData → file (by extension)
 first_sheet.save("sheet.json")       # SheetData → file (by extension)
 print(first_sheet.to_yaml())         # YAML text (requires pyyaml)
-# ExStructEngine: per-instance options for extraction/output
-from exstruct import ExStructEngine, StructOptions, OutputOptions
-engine = ExStructEngine(
-    options=StructOptions(mode="verbose"),  # verbose includes hyperlinks by default
-    output=OutputOptions(include_shapes=False, pretty=True),
-)
-wb2 = engine.extract("input.xlsx")
-engine.export(wb2, Path("out_filtered.json"))  # drops shapes via OutputOptions
-# Enable hyperlinks in other modes
-engine_links = ExStructEngine(options=StructOptions(mode="standard", include_cell_links=True))
-with_links = engine_links.extract("input.xlsx")
+# ExStructEngine: per-instance options for extraction/output
+from exstruct import ExStructEngine, StructOptions, OutputOptions
+engine = ExStructEngine(
+    options=StructOptions(mode="standard"),
+    output=OutputOptions(include_shapes=False, pretty=True),
+)
+wb2 = engine.extract("input.xlsx")
+engine.export(wb2, Path("out_filtered.json"))  # drops shapes via OutputOptions
 ```
 **Note (non-COM environments):** If Excel COM is unavailable, extraction still runs and returns cells + `table_candidates`; `shapes`/`charts` will be empty.
@@ -152,11 +148,11 @@ set_table_detection_params(
 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. Hyperlinks are off unless `include_cell_links=True`.
-- **verbose**: all shapes (with width/height), charts, table candidates, and cell hyperlinks.
+## 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
@@ -380,16 +376,15 @@ BSD-3-Clause. See `LICENSE` for details.
 - API Reference (GitHub Pages): https://harumiweb.github.io/exstruct/
 # Engine option cheat sheet
-| Option class   | Field               | Meaning |
-| -------------- | ------------------- | ------- |
-| StructOptions  | mode                | "light"/"standard"/"verbose" |
-|                | table_params        | Dict passed to `set_table_detection_params` (table_score_threshold, density_min, coverage_min, min_nonempty_cells) |
-|                | include_cell_links  | Include cell hyperlinks in `rows[*].links` (None -> auto: verbose=True, others=False) |
-| OutputOptions  | fmt                 | Default format ("json"/"yaml"/"yml"/"toon") |
-|                | pretty / indent     | Pretty-print JSON and control indent |
-|                | include_rows        | Include rows (False to drop) |
-|                | include_shapes      | Include shapes |
-|                | include_charts      | Include charts |
+| Option class   | Field               | Meaning |
+| -------------- | ------------------- | ------- |
+| StructOptions  | mode                | "light"/"standard"/"verbose" |
+|                | table_params        | Dict passed to `set_table_detection_params` (table_score_threshold, density_min, coverage_min, min_nonempty_cells) |
+| OutputOptions  | fmt                 | Default format ("json"/"yaml"/"yml"/"toon") |
+|                | pretty / indent     | Pretty-print JSON and control indent |
+|                | include_rows        | Include rows (False to drop) |
+|                | include_shapes      | Include shapes |
+|                | include_charts      | Include charts |
 |                | include_tables      | Include table_candidates |
 |                | sheets_dir          | Optional directory for per-sheet exports |
 |                | stream              | Default stream when output_path is None |

{exstruct-0.2.2 → exstruct-0.2.11}/README.md RENAMED Viewed

@@ -1,15 +1,15 @@
 # ExStruct — Excel Structured Extraction Engine
-[![PyPI version](https://badge.fury.io/py/exstruct.svg)](https://pypi.org/project/exstruct/) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/exstruct?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/exstruct) ![Licence: BSD-3-Clause](https://img.shields.io/badge/license-BSD--3--Clause-blue?style=flat-square) [![pytest](https://github.com/harumiWeb/exstruct/actions/workflows/pytest.yml/badge.svg)](https://github.com/harumiWeb/exstruct/actions/workflows/pytest.yml)
+[![PyPI version](https://badge.fury.io/py/exstruct.svg)](https://pypi.org/project/exstruct/) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/exstruct?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads)](https://pepy.tech/projects/exstruct) ![Licence: BSD-3-Clause](https://img.shields.io/badge/license-BSD--3--Clause-blue?style=flat-square) [![CI](https://github.com/harumiWeb/exstruct/actions/workflows/ci.yml/badge.svg)](https://github.com/harumiWeb/exstruct/actions/workflows/ci.yml)
 ![ExStruct Image](/docs/assets/icon.webp)
-ExStruct reads Excel workbooks and outputs structured data (tables, shapes, charts, hyperlinks) 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.
+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). Verbose also emits cell hyperlinks.
+- **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.
@@ -21,17 +21,17 @@ ExStruct reads Excel workbooks and outputs structured data (tables, shapes, char
 pip install exstruct
 ```
-Optional extras:
-- YAML: `pip install pyyaml`
-- TOON: `pip install python-toon`
-- Rendering (PDF/PNG): Excel + `pip install pypdfium2 pillow`
-- All extras at once: `pip install exstruct[yaml,toon,render]`
-Platform note:
-- Full extraction (shapes/charts) targets Windows + Excel (COM via xlwings). On other platforms, use `mode=light` to get cells + `table_candidates` safely.
-## Quick Start (CLI)
+Optional extras:
+- YAML: `pip install pyyaml`
+- TOON: `pip install python-toon`
+- Rendering (PDF/PNG): Excel + `pip install pypdfium2 pillow`
+- All extras at once: `pip install exstruct[yaml,toon,render]`
+Platform note:
+- Full extraction (shapes/charts) targets Windows + Excel (COM via xlwings). On other platforms, use `mode=light` to get cells + `table_candidates` safely.
+## Quick Start (CLI)
 ```bash
 exstruct input.xlsx > output.json          # compact JSON to stdout (default)
@@ -64,19 +64,15 @@ wb.save("out.json", pretty=True)     # WorkbookData → file (by extension)
 first_sheet.save("sheet.json")       # SheetData → file (by extension)
 print(first_sheet.to_yaml())         # YAML text (requires pyyaml)
-# ExStructEngine: per-instance options for extraction/output
-from exstruct import ExStructEngine, StructOptions, OutputOptions
-engine = ExStructEngine(
-    options=StructOptions(mode="verbose"),  # verbose includes hyperlinks by default
-    output=OutputOptions(include_shapes=False, pretty=True),
-)
-wb2 = engine.extract("input.xlsx")
-engine.export(wb2, Path("out_filtered.json"))  # drops shapes via OutputOptions
-# Enable hyperlinks in other modes
-engine_links = ExStructEngine(options=StructOptions(mode="standard", include_cell_links=True))
-with_links = engine_links.extract("input.xlsx")
+# ExStructEngine: per-instance options for extraction/output
+from exstruct import ExStructEngine, StructOptions, OutputOptions
+engine = ExStructEngine(
+    options=StructOptions(mode="standard"),
+    output=OutputOptions(include_shapes=False, pretty=True),
+)
+wb2 = engine.extract("input.xlsx")
+engine.export(wb2, Path("out_filtered.json"))  # drops shapes via OutputOptions
 ```
 **Note (non-COM environments):** If Excel COM is unavailable, extraction still runs and returns cells + `table_candidates`; `shapes`/`charts` will be empty.
@@ -96,11 +92,11 @@ set_table_detection_params(
 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. Hyperlinks are off unless `include_cell_links=True`.
-- **verbose**: all shapes (with width/height), charts, table candidates, and cell hyperlinks.
+## 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
@@ -324,16 +320,15 @@ BSD-3-Clause. See `LICENSE` for details.
 - API Reference (GitHub Pages): https://harumiweb.github.io/exstruct/
 # Engine option cheat sheet
-| Option class   | Field               | Meaning |
-| -------------- | ------------------- | ------- |
-| StructOptions  | mode                | "light"/"standard"/"verbose" |
-|                | table_params        | Dict passed to `set_table_detection_params` (table_score_threshold, density_min, coverage_min, min_nonempty_cells) |
-|                | include_cell_links  | Include cell hyperlinks in `rows[*].links` (None -> auto: verbose=True, others=False) |
-| OutputOptions  | fmt                 | Default format ("json"/"yaml"/"yml"/"toon") |
-|                | pretty / indent     | Pretty-print JSON and control indent |
-|                | include_rows        | Include rows (False to drop) |
-|                | include_shapes      | Include shapes |
-|                | include_charts      | Include charts |
+| Option class   | Field               | Meaning |
+| -------------- | ------------------- | ------- |
+| StructOptions  | mode                | "light"/"standard"/"verbose" |
+|                | table_params        | Dict passed to `set_table_detection_params` (table_score_threshold, density_min, coverage_min, min_nonempty_cells) |
+| OutputOptions  | fmt                 | Default format ("json"/"yaml"/"yml"/"toon") |
+|                | pretty / indent     | Pretty-print JSON and control indent |
+|                | include_rows        | Include rows (False to drop) |
+|                | include_shapes      | Include shapes |
+|                | include_charts      | Include charts |
 |                | include_tables      | Include table_candidates |
 |                | sheets_dir          | Optional directory for per-sheet exports |
 |                | stream              | Default stream when output_path is None |

{exstruct-0.2.2 → exstruct-0.2.11}/pyproject.toml RENAMED Viewed

@@ -1,6 +1,6 @@
 [project]
 name = "exstruct"
-version = "0.2.2"
+version = "0.2.11"
 description = "Excel to structured JSON (tables, shapes, charts) for LLM/RAG pipelines"
 readme = "README.md"
 license = { file = "LICENSE" }

{exstruct-0.2.2 → exstruct-0.2.11}/src/exstruct/__init__.py RENAMED Viewed

@@ -36,8 +36,7 @@ ExtractionMode = Literal["light", "standard", "verbose"]
 def extract(file_path: str | Path, mode: ExtractionMode = "standard") -> WorkbookData:
     """Extract workbook semantic structure and return WorkbookData."""
-    include_links = True if mode == "verbose" else False
-    engine = ExStructEngine(options=StructOptions(mode=mode, include_cell_links=include_links))
+    engine = ExStructEngine(options=StructOptions(mode=mode))
     return engine.extract(file_path, mode=mode)

{exstruct-0.2.2 → exstruct-0.2.11}/src/exstruct/core/cells.py RENAMED Viewed

@@ -33,64 +33,25 @@ def warn_once(key: str, message: str) -> None:
         _warned_keys.add(key)
-def extract_sheet_cells(file_path: Path) -> Dict[str, List[CellRow]]:
-    """Read all sheets via pandas and convert to CellRow list while skipping empty cells."""
-    dfs = pd.read_excel(file_path, header=None, sheet_name=None, dtype=str)
-    result: Dict[str, List[CellRow]] = {}
-    for sheet_name, df in dfs.items():
-        df = df.fillna("")
-        rows: List[CellRow] = []
-        for excel_row, row in enumerate(df.itertuples(index=False, name=None), start=1):
-            filtered: Dict[str, int | float | str] = {}
-            for j, v in enumerate(row):
-                s = "" if v is None else str(v)
-                if s.strip() == "":
-                    continue
-                filtered[str(j)] = _coerce_numeric_preserve_format(s)
-            if not filtered:
-                continue
-            rows.append(CellRow(r=excel_row, c=filtered))
-        result[sheet_name] = rows
-    return result
-def extract_sheet_cells_with_links(file_path: Path) -> Dict[str, List[CellRow]]:
-    """
-    Extract cells and hyperlinks per sheet.
-    Returns:
-        {sheet_name: [CellRow(r=..., c=..., links={"col_index": url, ...}), ...]}
-    Notes:
-        - Uses pandas extraction for values (same filtering as extract_sheet_cells).
-        - Collects hyperlinks via openpyxl (requires read_only=False because border maps/hyperlinks need full objects).
-        - Links are mapped by column index string (e.g., "0") to hyperlink.target.
-    """
-    cell_rows = extract_sheet_cells(file_path)
-    wb = load_workbook(file_path, data_only=True, read_only=False)
-    links_by_sheet: Dict[str, Dict[int, Dict[str, str]]] = {}
-    for ws in wb.worksheets:
-        sheet_links: Dict[int, Dict[str, str]] = {}
-        for row in ws.iter_rows():
-            for cell in row:
-                link = getattr(cell, "hyperlink", None)
-                target = getattr(link, "target", None) if link else None
-                if not target:
-                    continue
-                col_str = str(cell.col_idx - 1)  # zero-based to align with extract_sheet_cells
-                sheet_links.setdefault(cell.row, {})[col_str] = target
-        links_by_sheet[ws.title] = sheet_links
-    merged: Dict[str, List[CellRow]] = {}
-    for sheet_name, rows in cell_rows.items():
-        sheet_links = links_by_sheet.get(sheet_name, {})
-        merged_rows: List[CellRow] = []
-        for row in rows:
-            links = sheet_links.get(row.r, {})
-            merged_rows.append(CellRow(r=row.r, c=row.c, links=links or None))
-        merged[sheet_name] = merged_rows
-    wb.close()
-    return merged
+def extract_sheet_cells(file_path: Path) -> Dict[str, List[CellRow]]:
+    """Read all sheets via pandas and convert to CellRow list while skipping empty cells."""
+    dfs = pd.read_excel(file_path, header=None, sheet_name=None, dtype=str)
+    result: Dict[str, List[CellRow]] = {}
+    for sheet_name, df in dfs.items():
+        df = df.fillna("")
+        rows: List[CellRow] = []
+        for excel_row, row in enumerate(df.itertuples(index=False, name=None), start=1):
+            filtered: Dict[str, int | float | str] = {}
+            for j, v in enumerate(row):
+                s = "" if v is None else str(v)
+                if s.strip() == "":
+                    continue
+                filtered[str(j)] = _coerce_numeric_preserve_format(s)
+            if not filtered:
+                continue
+            rows.append(CellRow(r=excel_row, c=filtered))
+        result[sheet_name] = rows
+    return result
 def shrink_to_content(

{exstruct-0.2.2 → exstruct-0.2.11}/src/exstruct/core/integrate.py RENAMED Viewed

@@ -4,17 +4,15 @@ from pathlib import Path
 from typing import Dict, List, Literal
 import logging
-import os
 import xlwings as xw
 from ..models import CellRow, Shape, SheetData, WorkbookData
-from .cells import (
-    detect_tables,
-    detect_tables_openpyxl,
-    extract_sheet_cells,
-    extract_sheet_cells_with_links,
-)
+from .cells import (
+    detect_tables,
+    detect_tables_openpyxl,
+    extract_sheet_cells,
+)
 from .charts import get_charts
 from .shapes import get_shapes_with_position
@@ -76,16 +74,13 @@ def integrate_sheet_content(
 def extract_workbook(
-    file_path: Path,
-    mode: Literal["light", "standard", "verbose"] = "standard",
-    *,
-    include_cell_links: bool = False,
+    file_path: Path, mode: Literal["light", "standard", "verbose"] = "standard"
 ) -> WorkbookData:
     """Extract workbook and return WorkbookData; fallback to cells+tables if Excel COM is unavailable."""
     if mode not in _ALLOWED_MODES:
         raise ValueError(f"Unsupported mode: {mode}")
-    cell_data = extract_sheet_cells_with_links(file_path) if include_cell_links else extract_sheet_cells(file_path)
+    cell_data = extract_sheet_cells(file_path)
     def _cells_and_tables_only(reason: str) -> WorkbookData:
         sheets: Dict[str, SheetData] = {}
@@ -109,9 +104,6 @@ def extract_workbook(
     if mode == "light":
         return _cells_and_tables_only("Light mode selected.")
-    if os.getenv("SKIP_COM_TESTS"):
-        return _cells_and_tables_only("SKIP_COM_TESTS is set; skipping COM/xlwings access.")
     try:
         wb, close_app = _open_workbook(file_path)
     except Exception as e:

{exstruct-0.2.2 → exstruct-0.2.11}/src/exstruct/engine.py RENAMED Viewed

@@ -32,7 +32,6 @@ class StructOptions:
     mode: ExtractionMode = "standard"
     table_params: Optional[dict] = None  # forwarded to set_table_detection_params if provided
-    include_cell_links: Optional[bool] = None  # None → auto: verbose=True, others=False
 @dataclass(frozen=True)
@@ -134,13 +133,8 @@ class ExStructEngine:
         chosen_mode = mode or self.options.mode
         if chosen_mode not in ("light", "standard", "verbose"):
             raise ValueError(f"Unsupported mode: {chosen_mode}")
-        include_links = (
-            self.options.include_cell_links
-            if self.options.include_cell_links is not None
-            else chosen_mode == "verbose"
-        )
         with self._table_params_scope():
-            return extract_workbook(Path(file_path), mode=chosen_mode, include_cell_links=include_links)
+            return extract_workbook(Path(file_path), mode=chosen_mode)
     def serialize(
         self,

{exstruct-0.2.2 → exstruct-0.2.11}/src/exstruct/models/__init__.py RENAMED Viewed

@@ -23,7 +23,6 @@ class Shape(BaseModel):
 class CellRow(BaseModel):
     r: int
     c: Dict[str, int | float | str]
-    links: Optional[Dict[str, str]] = None
 class ChartSeries(BaseModel):