exstruct 0.2.51__tar.gz → 0.2.61__tar.gz

{exstruct-0.2.51 → exstruct-0.2.61}/PKG-INFO

@@ -1,10 +1,9 @@
 Metadata-Version: 2.3
 Name: exstruct
-Version: 0.2.51
+Version: 0.2.61
 Summary: Excel to structured JSON (tables, shapes, charts) for LLM/RAG pipelines
 Keywords: excel,structure,data,exstruct
 Author: harumiWeb
-Author-email: harumiWeb <ganaharumi@outlook.jp>
 License: BSD 3-Clause License
          
          Copyright (c) 2025, ExStruct Contributors
@@ -60,12 +59,15 @@ Description-Content-Type: text/markdown
 
 ![ExStruct Image](/docs/assets/icon.webp)
 
-ExStruct reads Excel workbooks and outputs structured data (cells, table candidates, shapes, charts, print areas/views, 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 + print areas), with tunable detection heuristics and multiple output modes to fit LLM/RAG pipelines.
+ExStruct reads Excel workbooks and outputs structured data (cells, table candidates, shapes, charts, print areas/views, auto page-break areas, 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 + print areas), with tunable detection heuristics and multiple output modes to fit LLM/RAG pipelines.
+
+[日本版README](README.ja.md)
 
 ## Features
 
-- **Excel → Structured JSON**: cells, shapes, charts, table candidates, and print areas/views per sheet.
+- **Excel → Structured JSON**: cells, shapes, charts, table candidates, print areas/views, and auto page-break areas per sheet.
 - **Output modes**: `light` (cells + table candidates + print areas; no COM, shapes/charts empty), `standard` (texted shapes + arrows, charts, print areas), `verbose` (all shapes with width/height, charts with size, print areas). Verbose also emits cell hyperlinks. Size output is flag-controlled.
+- **Auto page-break export (COM only)**: capture Excel-computed auto page breaks and write per-area JSON/YAML/TOON when requested.
 - **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.
@@ -101,6 +103,8 @@ exstruct input.xlsx --mode light           # cells + table candidates only
 exstruct input.xlsx --pdf --image          # PDF and PNGs (Excel required)
 ```
 
+Auto page-break exports are API-only (Excel/COM): set `DestinationOptions.auto_page_breaks_dir` or call `export_auto_page_breaks(...)`.
+
 ## Quick Start (Python)
 
 ```python
@@ -122,27 +126,45 @@ 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 (nested configs)
-from exstruct import ExStructEngine, StructOptions, OutputOptions, FormatOptions, FilterOptions, DestinationOptions
-
-engine = ExStructEngine(
-    options=StructOptions(mode="verbose"),  # verbose includes hyperlinks by default
-    output=OutputOptions(
-        format=FormatOptions(pretty=True),
-        filters=FilterOptions(include_shapes=False),  # drop shapes in output
-        destinations=DestinationOptions(sheets_dir=Path("out_sheets")),  # also write per-sheet files
-    ),
-)
-wb2 = engine.extract("input.xlsx")
-engine.export(wb2, Path("out_filtered.json"))  # drops shapes via filters
-
-# 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 (nested configs)
+from exstruct import (
+    DestinationOptions,
+    ExStructEngine,
+    FilterOptions,
+    FormatOptions,
+    OutputOptions,
+    StructOptions,
+    export_auto_page_breaks,
+)
+
+engine = ExStructEngine(
+    options=StructOptions(mode="verbose"),  # verbose includes hyperlinks by default
+    output=OutputOptions(
+        format=FormatOptions(pretty=True),
+        filters=FilterOptions(include_shapes=False),  # drop shapes in output
+        destinations=DestinationOptions(sheets_dir=Path("out_sheets")),  # also write per-sheet files
+    ),
+)
+wb2 = engine.extract("input.xlsx")
+engine.export(wb2, Path("out_filtered.json"))  # drops shapes via filters
+
+# Enable hyperlinks in other modes
+engine_links = ExStructEngine(options=StructOptions(mode="standard", include_cell_links=True))
+with_links = engine_links.extract("input.xlsx")
 
 # Export per print area (if print areas exist)
 from exstruct import export_print_areas_as
 export_print_areas_as(wb, "areas", fmt="json", pretty=True)
+
+# Auto page-break extraction/output (COM only; raises if no auto breaks exist)
+engine_auto = ExStructEngine(
+    output=OutputOptions(
+        destinations=DestinationOptions(auto_page_breaks_dir=Path("auto_areas"))
+    )
+)
+wb_auto = engine_auto.extract("input.xlsx")  # includes SheetData.auto_print_areas
+engine_auto.export(wb_auto, Path("out_with_auto.json"))  # also writes auto_areas/*
+export_auto_page_breaks(wb_auto, "auto_areas", fmt="json", pretty=True)  # manual writer
 ```
 
 **Note (non-COM environments):** If Excel COM is unavailable, extraction still runs and returns cells + `table_candidates`; `shapes`/`charts` will be empty.
@@ -382,10 +404,12 @@ In short, **exstruct = “an engine that converts Excel into a format AI can und
 - Default JSON is compact to reduce tokens; use `--pretty` or `pretty=True` when readability matters.
 - Field `table_candidates` replaces `tables`; adjust downstream consumers accordingly.
 
-## Print Areas (PrintArea / PrintAreaView)
+## Print Areas and Auto Page Breaks (PrintArea / PrintAreaView)
 
 - `SheetData.print_areas` holds print areas (cell coordinates) in light/standard/verbose.
+- `SheetData.auto_print_areas` holds Excel COM-computed auto page-break areas when auto page-break extraction is enabled (COM only).
 - Use `export_print_areas_as(...)` or CLI `--print-areas-dir` to write one file per print area (nothing is written if none exist).
+- Use `DestinationOptions.auto_page_breaks_dir` (preferred) or `export_auto_page_breaks(...)` to write per-auto-page-break files; the API raises `ValueError` if no auto page breaks exist.
 - `PrintAreaView` includes rows and table candidates inside the area, plus shapes/charts that overlap the area (size-less shapes are treated as points). `normalize=True` rebases row/col indices to the area origin.
 
 ## License

{exstruct-0.2.51 → exstruct-0.2.61}/README.md

@@ -4,12 +4,15 @@
 
 ![ExStruct Image](/docs/assets/icon.webp)
 
-ExStruct reads Excel workbooks and outputs structured data (cells, table candidates, shapes, charts, print areas/views, 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 + print areas), with tunable detection heuristics and multiple output modes to fit LLM/RAG pipelines.
+ExStruct reads Excel workbooks and outputs structured data (cells, table candidates, shapes, charts, print areas/views, auto page-break areas, 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 + print areas), with tunable detection heuristics and multiple output modes to fit LLM/RAG pipelines.
+
+[日本版README](README.ja.md)
 
 ## Features
 
-- **Excel → Structured JSON**: cells, shapes, charts, table candidates, and print areas/views per sheet.
+- **Excel → Structured JSON**: cells, shapes, charts, table candidates, print areas/views, and auto page-break areas per sheet.
 - **Output modes**: `light` (cells + table candidates + print areas; no COM, shapes/charts empty), `standard` (texted shapes + arrows, charts, print areas), `verbose` (all shapes with width/height, charts with size, print areas). Verbose also emits cell hyperlinks. Size output is flag-controlled.
+- **Auto page-break export (COM only)**: capture Excel-computed auto page breaks and write per-area JSON/YAML/TOON when requested.
 - **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.
@@ -45,6 +48,8 @@ exstruct input.xlsx --mode light           # cells + table candidates only
 exstruct input.xlsx --pdf --image          # PDF and PNGs (Excel required)
 ```
 
+Auto page-break exports are API-only (Excel/COM): set `DestinationOptions.auto_page_breaks_dir` or call `export_auto_page_breaks(...)`.
+
 ## Quick Start (Python)
 
 ```python
@@ -66,27 +71,45 @@ 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 (nested configs)
-from exstruct import ExStructEngine, StructOptions, OutputOptions, FormatOptions, FilterOptions, DestinationOptions
-
-engine = ExStructEngine(
-    options=StructOptions(mode="verbose"),  # verbose includes hyperlinks by default
-    output=OutputOptions(
-        format=FormatOptions(pretty=True),
-        filters=FilterOptions(include_shapes=False),  # drop shapes in output
-        destinations=DestinationOptions(sheets_dir=Path("out_sheets")),  # also write per-sheet files
-    ),
-)
-wb2 = engine.extract("input.xlsx")
-engine.export(wb2, Path("out_filtered.json"))  # drops shapes via filters
-
-# 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 (nested configs)
+from exstruct import (
+    DestinationOptions,
+    ExStructEngine,
+    FilterOptions,
+    FormatOptions,
+    OutputOptions,
+    StructOptions,
+    export_auto_page_breaks,
+)
+
+engine = ExStructEngine(
+    options=StructOptions(mode="verbose"),  # verbose includes hyperlinks by default
+    output=OutputOptions(
+        format=FormatOptions(pretty=True),
+        filters=FilterOptions(include_shapes=False),  # drop shapes in output
+        destinations=DestinationOptions(sheets_dir=Path("out_sheets")),  # also write per-sheet files
+    ),
+)
+wb2 = engine.extract("input.xlsx")
+engine.export(wb2, Path("out_filtered.json"))  # drops shapes via filters
+
+# Enable hyperlinks in other modes
+engine_links = ExStructEngine(options=StructOptions(mode="standard", include_cell_links=True))
+with_links = engine_links.extract("input.xlsx")
 
 # Export per print area (if print areas exist)
 from exstruct import export_print_areas_as
 export_print_areas_as(wb, "areas", fmt="json", pretty=True)
+
+# Auto page-break extraction/output (COM only; raises if no auto breaks exist)
+engine_auto = ExStructEngine(
+    output=OutputOptions(
+        destinations=DestinationOptions(auto_page_breaks_dir=Path("auto_areas"))
+    )
+)
+wb_auto = engine_auto.extract("input.xlsx")  # includes SheetData.auto_print_areas
+engine_auto.export(wb_auto, Path("out_with_auto.json"))  # also writes auto_areas/*
+export_auto_page_breaks(wb_auto, "auto_areas", fmt="json", pretty=True)  # manual writer
 ```
 
 **Note (non-COM environments):** If Excel COM is unavailable, extraction still runs and returns cells + `table_candidates`; `shapes`/`charts` will be empty.
@@ -326,10 +349,12 @@ In short, **exstruct = “an engine that converts Excel into a format AI can und
 - Default JSON is compact to reduce tokens; use `--pretty` or `pretty=True` when readability matters.
 - Field `table_candidates` replaces `tables`; adjust downstream consumers accordingly.
 
-## Print Areas (PrintArea / PrintAreaView)
+## Print Areas and Auto Page Breaks (PrintArea / PrintAreaView)
 
 - `SheetData.print_areas` holds print areas (cell coordinates) in light/standard/verbose.
+- `SheetData.auto_print_areas` holds Excel COM-computed auto page-break areas when auto page-break extraction is enabled (COM only).
 - Use `export_print_areas_as(...)` or CLI `--print-areas-dir` to write one file per print area (nothing is written if none exist).
+- Use `DestinationOptions.auto_page_breaks_dir` (preferred) or `export_auto_page_breaks(...)` to write per-auto-page-break files; the API raises `ValueError` if no auto page breaks exist.
 - `PrintAreaView` includes rows and table candidates inside the area, plus shapes/charts that overlap the area (size-less shapes are treated as points). `normalize=True` rebases row/col indices to the area origin.
 
 ## License

{exstruct-0.2.51 → exstruct-0.2.61}/pyproject.toml

@@ -1,111 +1,118 @@
-[project]
-name = "exstruct"
-version = "0.2.51"
-description = "Excel to structured JSON (tables, shapes, charts) for LLM/RAG pipelines"
-readme = "README.md"
-license = { file = "LICENSE" }
-keywords = ["excel", "structure", "data", "exstruct"]
-authors = [
-    { name = "harumiWeb", email = "ganaharumi@outlook.jp" }
-]
-requires-python = ">=3.11"
-dependencies = [
-    "numpy>=2.3.5",
-    "openpyxl>=3.1.5",
-    "pandas>=2.3.3",
-    "pydantic>=2.12.5",
-    "scipy>=1.16.3",
-    "xlwings>=0.33.16",
-]
-
-[build-system]
-requires = ["uv_build>=0.8.4,<0.9.0"]
-build-backend = "uv_build"
-
-[dependency-groups]
-dev = [
-    "mkdocs-material>=9.7.0",
-    "mypy>=1.19.0",
-    "pytest>=9.0.1",
-    "pytest-cov>=7.0.0",
-    "pytest-mock>=3.15.1",
-    "ruff>=0.14.8",
-]
-
-[project.optional-dependencies]
-yaml = ["pyyaml>=6.0.3"]
-toon = ["python-toon>=0.1.3"]
-render = ["pypdfium2>=5.1.0", "Pillow>=12.0.0"]
-
-[project.scripts]
-exstruct = "exstruct.cli.main:main"
-
-[project.urls]
-Homepage = "https://harumiweb.github.io/exstruct/"
-Repository = "https://github.com/harumiWeb/exstruct"
-Issues = "https://github.com/harumiWeb/exstruct/issues"
-Documentation = "https://harumiweb.github.io/exstruct/"
-
-[tool.coverage.run]
-omit = [
-    "tests/*",
-    "*/test_*.py",
-    "*/gen_py/*",
-]
-
-[tool.ruff]
-target-version = "py311"
-src = ["exstruct"]
-
-select = [
-    "E",   # pycodestyle errors
-    "W",   # pycodestyle warnings
-    "F",   # pyflakes
-    "I",   # import sorting
-    "UP",  # pyupgrade
-    "B",   # flake8-bugbear
-    "N",   # naming
-    "C90", # complexity
-    "A",   # flake8-builtins
-    "ANN", # type annotations
-]
-
-ignore = [
-    "E501",   # 行長は許容（Excel JSON は長くなりがち）
-    "B008",   # Pydantic の default_factory を誤検知するため
-    "ANN101", # self に型を要求されてしまうため
-    "ANN102", # cls も同様
-]
-
-fix = true
-
-# 型ヒントのスタイル
-[tool.ruff.lint]
-extend-select = ["ANN"]
-
-# import の並び替え設定
-[tool.ruff.isort]
-combine-as-imports = true
-known-first-party = ["exstruct"]
-force-sort-within-sections = true
-
-# 複雑度チェック（関数の最大複雑度）
-[tool.ruff.mccabe]
-max-complexity = 12
-
-[tool.ruff.per-file-ignores]
-"tests/**/*.py" = ["N802", "N803", "N806"]
-
-
-[tool.mypy]
-packages = ["exstruct"]
-python_version = "3.11"
-
-# 外部ライブラリは一切チェックしない
-ignore_missing_imports = true
-
-# 自作コードは厳密にチェックする
-strict = true
-
-# Pydantic v2 向け
-plugins = ["pydantic.mypy"]
+[project]
+name = "exstruct"
+version = "0.2.61"
+description = "Excel to structured JSON (tables, shapes, charts) for LLM/RAG pipelines"
+readme = "README.md"
+license = { file = "LICENSE" }
+keywords = ["excel", "structure", "data", "exstruct"]
+authors = [
+    { name = "harumiWeb"}
+]
+requires-python = ">=3.11"
+dependencies = [
+    "numpy>=2.3.5",
+    "openpyxl>=3.1.5",
+    "pandas>=2.3.3",
+    "pydantic>=2.12.5",
+    "scipy>=1.16.3",
+    "xlwings>=0.33.16",
+]
+
+[build-system]
+requires = ["uv_build>=0.8.4,<0.9.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mkdocs-material>=9.7.0",
+    "mypy>=1.19.0",
+    "pre-commit>=4.5.0",
+    "pytest>=9.0.1",
+    "pytest-cov>=7.0.0",
+    "pytest-mock>=3.15.1",
+    "ruff>=0.14.8",
+]
+
+[project.optional-dependencies]
+yaml = ["pyyaml>=6.0.3"]
+toon = ["python-toon>=0.1.3"]
+render = ["pypdfium2>=5.1.0", "Pillow>=12.0.0"]
+
+[project.scripts]
+exstruct = "exstruct.cli.main:main"
+
+[project.urls]
+Homepage = "https://harumiweb.github.io/exstruct/"
+Repository = "https://github.com/harumiWeb/exstruct"
+Issues = "https://github.com/harumiWeb/exstruct/issues"
+Documentation = "https://harumiweb.github.io/exstruct/"
+
+[tool.coverage.run]
+omit = [
+    "tests/*",
+    "*/test_*.py",
+    "*/gen_py/*",
+]
+
+[tool.ruff]
+target-version = "py311"
+src = ["exstruct"]
+
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # import sorting
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "N",   # naming
+    "C90", # complexity
+    "A",   # flake8-builtins
+    "ANN", # type annotations
+]
+
+ignore = [
+    "E501",   # 行長は許容（Excel JSON は長くなりがち）
+    "B008",   # Pydantic の default_factory を誤検知するため
+    "ANN101", # self に型を要求されてしまうため
+    "ANN102", # cls も同様
+]
+
+fix = true
+
+# 型ヒントのスタイル
+[tool.ruff.lint]
+extend-select = ["ANN"]
+
+# import の並び替え設定
+[tool.ruff.isort]
+combine-as-imports = true
+known-first-party = ["exstruct"]
+force-sort-within-sections = true
+
+# 複雑度チェック（関数の最大複雑度）
+[tool.ruff.mccabe]
+max-complexity = 12
+
+[tool.ruff.per-file-ignores]
+"tests/**/*.py" = ["N802", "N803", "N806"]
+
+
+[tool.mypy]
+packages = ["exstruct"]
+python_version = "3.11"
+
+# 外部ライブラリは一切チェックしない
+ignore_missing_imports = true
+
+# 自作コードは厳密にチェックする
+strict = true
+
+# Pydantic v2 向け
+plugins = ["pydantic.mypy"]
+
+[tool.pytest.ini_options]
+markers = [
+    "com: requires Excel COM (Windows + Excel)",
+    "render: requires Excel COM and pypdfium2; set RUN_RENDER_SMOKE=1 to enable",
+]