section-anything 0.1.0__tar.gz

section_anything-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

section_anything-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE NOTICE README.md
+recursive-include tests *.py

section_anything-0.1.0/NOTICE

@@ -0,0 +1,9 @@
+Section Anything
+Copyright 2026 The Section Anything Authors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+It uses, without bundling, pdfplumber and pdfminer.six (MIT), pypdfium2 and
+PDFium (Apache-2.0 / BSD-3-Clause), RapidFuzz (MIT), the OpenAI Python library
+(Apache-2.0) and pydantic (MIT). Each is installed separately under its own
+licence.

section_anything-0.1.0/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: section-anything
+Version: 0.1.0
+Summary: Find the sections of a PDF (headings, levels, page and character spans), from free rules to LLM review, with hard cost caps.
+Author: The Section Anything Authors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://omniwot.github.io/section-anything/
+Project-URL: Repository, https://github.com/Omniwot/section-anything
+Project-URL: Issues, https://github.com/Omniwot/section-anything/issues
+Keywords: pdf,headings,sections,table of contents,document structure,rag,chunking
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Processing :: General
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pdfplumber>=0.11.8
+Requires-Dist: pdfminer.six>=20251107
+Requires-Dist: pypdfium2>=4.30
+Requires-Dist: rapidfuzz>=3.9
+Requires-Dist: openai>=1.99
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pydantic-settings>=2.6
+Provides-Extra: langfuse
+Requires-Dist: langfuse>=2.57; extra == "langfuse"
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Dynamic: license-file
+
+# section-anything
+
+> **Pre-release (0.1).** The API may change before 1.0.
+
+Find the sections of a PDF: every heading, its level, the pages it spans and its exact
+character range in the extracted text. One call, with a dial from free rules to an LLM that
+reads the whole document, and a hard cost cap on every paid run.
+
+```python
+import section_anything
+
+tree = section_anything.section("paper.pdf", mode="quick")
+print(tree.to_markdown())
+# # A Study of Sectioning
+# ## 1 Introduction
+# ### 1.1 Scope
+# ## 2 Methods
+print(tree.sections[1])
+# {'number': '1', 'title': 'Introduction', 'level': 1, 'page_start': 1, 'page_end': 1,
+#  'start': 22, 'end': 484, 'flags': []}
+print(tree.summary())  # mode, model, pages, sections, calls, tokens, cost_usd, seconds
+```
+
+## Install
+
+Python 3.11+:
+
+```sh
+pip install section-anything
+pip install "section-anything[langfuse]"  # optional Langfuse tracing
+# latest from GitHub:
+pip install "git+https://github.com/Omniwot/section-anything#subdirectory=packages/section-anything"
+# from a checkout of the repository:
+pip install -e ./packages/section-anything
+```
+
+Dependencies: pdfplumber and pdfminer.six (MIT), pypdfium2 (Apache-2.0 / BSD-3-Clause),
+RapidFuzz (MIT), openai (Apache-2.0), pydantic and pydantic-settings (MIT). No PyMuPDF (AGPL).
+
+## Modes
+
+| Mode | What runs | Sent to a model | Cost per 1,000 pages |
+|---|---|---|---|
+| `free` (default) | PDF bookmarks or the printed table of contents as the outline, then typography and numbering rules; headings a complete-looking outline does not list are dropped | nothing | $0 |
+| `quick` | the rules propose candidate heading lines; a small model keeps the real ones and sets levels | candidate lines and a 70-character peek at the next line | about $0.07 (`gpt-6-luna`) |
+| `standard` | a model reads every line, with font hints, and marks where sections start and end | the document text | about $0.16 (`gpt-6-luna`), $2.90 (`gpt-6.1-sol`, the default) |
+| `local:<model>` | `quick`, answered by a local [Ollama](https://ollama.com) model | nothing leaves the machine | $0 |
+
+Costs are measured averages at the built-in list prices; your documents may differ.
+
+## Command line
+
+```sh
+section-anything paper.pdf                                   # free, Markdown headings
+section-anything paper.pdf --mode quick --format json        # JSON with spans and cost
+section-anything paper.pdf --mode standard --max-usd 0.5     # cap this document at $0.50
+section-anything paper.pdf --mode local:qwen3:4b --body      # headings plus section text
+```
+
+The result goes to stdout (or `-o FILE`), a one-line summary with the cost to stderr. Exit codes:
+0 done, 2 configuration (for example no API key), 3 refused by the cost cap, 4 the PDF could not
+be read. API keys are read from the environment only, never from the command line.
+
+## Output
+
+`tree.sections` is a list of dicts in reading order:
+
+| Key | Meaning |
+|---|---|
+| `number`, `title` | numbering as printed (`"2.3"`, `"Chapter 4"`, or `""`) and the heading text |
+| `level` | 1 = top level, 2 = its subsections, ... |
+| `page_start`, `page_end` | 1-based physical pages |
+| `start`, `end` | character range of the section's own text in `tree.text` (up to the next heading) |
+| `flags` | `doc_title` (the document's own title), `front_matter` (text before the first heading), `generated_title` (`standard` wrote a title for text that has no printed heading), and checks such as `start_marker_fuzzy`, `title_not_in_text`, `end_mismatch` |
+
+- `tree.to_markdown()`: the document title as `#`, every other heading as `#` x (level + 1),
+  capped at six. `to_markdown(body=True)` adds each section's text, reflowed into paragraphs,
+  with running headers and footers removed.
+- `tree.to_json()` / `tree.to_dict()`: the sections plus mode, model, pages, calls, tokens,
+  cost and any downgrades.
+- `tree.extraction` holds the lines with their boxes (PDF points), for highlighting.
+
+## Configuration
+
+Every setting can be passed in code or set as an environment variable `SECTIONANY_<NAME>`.
+Arguments win over the environment. **No `.env` file is read, and nothing is ever written to
+`os.environ`.**
+
+| Setting | Default | |
+|---|---|---|
+| `SECTIONANY_API_KEY` / `api_key=` | (none) | Falls back to `OPENAI_API_KEY` only while `base_url` is OpenAI's own endpoint |
+| `SECTIONANY_BASE_URL` / `base_url=` | `https://api.openai.com/v1` | Any OpenAI-compatible endpoint with JSON-schema outputs; always passed explicitly to the client |
+| `SECTIONANY_QUICK_MODEL`, `SECTIONANY_STANDARD_MODEL` / `model=` | `gpt-6-luna`, `gpt-6.1-sol` | |
+| `SECTIONANY_LOCAL_MODEL` | (none) | Ollama tag for `local` |
+| `SECTIONANY_OLLAMA_BASE_URL` | `http://localhost:11434/v1` | |
+| `SECTIONANY_PRICES` / `prices=` | built-in list | JSON `{"model": {"input": 2.0, "output": 10.0, "cached": 0.1}}`, USD per 1M tokens, merged over the built-in list |
+| `SECTIONANY_MAX_USD_PER_DOC` / `max_usd=` | `0.50` | hard per-document cap |
+| `SECTIONANY_OVER_BUDGET` / `over_budget=` | `downgrade` | or `fail` |
+| `SECTIONANY_MAX_PAGES`, `SECTIONANY_MAX_CHARS`, `SECTIONANY_MAX_MB` | 500, 5,000,000, 100 | refused above these |
+| `SECTIONANY_DEMOTE_UNLISTED_HEADINGS` / `demote_unlisted_headings=` | `["free"]` | modes in which sections that a complete-looking PDF outline does not list are dropped (JSON list; `[]` turns it off) |
+| `SECTIONANY_EXTRACT_TIMEOUT_SECONDS` / `extract_timeout=` | 120 | extraction worker is killed after this |
+| `SECTIONANY_EXTRACT_MEMORY_MB` | 4096 | worker memory limit (Linux only; 0 = none) |
+| `SECTIONANY_ISOLATE_EXTRACTION` | `true` | run extraction in a separate process |
+| `SECTIONANY_DEMOTE_UNLISTED_HEADINGS` | `[]` (off) | JSON list of modes (`free`, `quick`, `standard`): when the PDF's bookmarks look complete, drop sections they do not list (`section_anything.outline_check`) |
+| `SECTIONANY_LLM_TIMEOUT_SECONDS`, `SECTIONANY_LOCAL_TIMEOUT_SECONDS` | 300, 600 | per model call |
+| `SECTIONANY_STORE_PROMPTS` | `false` | keep prompt text in call records passed to a `Usage(sink=...)` |
+| `SECTIONANY_LANGFUSE` | `false` | trace calls with Langfuse (needs the `langfuse` extra and Langfuse's own keys) |
+
+Or build a `Settings` object once: `section(pdf, "quick", settings=Settings(max_usd_per_doc=1.0))`.
+Async code can `await section_anything.asection(...)`.
+
+## Costs and caps
+
+- **Unknown prices are refused.** A cloud model with no price (built-in, `SECTIONANY_PRICES` or
+  `prices=`) is refused before the PDF is read, so the cap can always be enforced. Local models
+  are free.
+- **Estimate first.** Before a paid mode runs, its cost is estimated from the document. Over
+  `max_usd`, the run is downgraded (standard -> quick -> free) and the downgrade is reported in
+  `tree.downgraded`, or refused with `CostCapExceeded` when `over_budget="fail"`.
+- **Hard cap while running.** The cap is re-checked before every model call, and each call's
+  output tokens are limited to what the remaining budget can pay for. A downgrade continues the
+  same budget. The SDK's own retries are off; one retry on an unusable answer is counted.
+- The built-in prices are list prices from October 2026. Check your provider's prices and
+  override them with `SECTIONANY_PRICES`.
+
+## Handling untrusted PDFs
+
+- File size and page count are checked first, from the PDF's page tree, without parsing any
+  page content.
+- Text extraction runs in a separate Python process: the text size is counted (PDFium) before
+  layout analysis starts, the process is killed at the time limit, has a memory limit on Linux,
+  runs in an empty temporary directory, and inherits no API keys. It returns JSON, not pickles.
+- Document text is treated as untrusted in every prompt; model output is validated against a
+  schema and clipped (strings to 300 characters, lists to 2,000 items). In `quick`, a heading
+  title the model rewrote is replaced by the printed line; in `standard`, titles the model wrote
+  for headingless text are flagged `generated_title`.
+- Log messages and errors name the error type, HTTP status and error code, never prompt or
+  response text.
+
+## Benchmarks (summary)
+
+Heading-tree similarity (TEDS, 0-100, higher is better) with
+[READoc](https://github.com/icip-cas/READoc)'s own scoring code, October 2026. The full tables,
+methods and per-document results are in the repository: `site/data/results.js` (rendered by the
+project site in `site/`) and `corpus/results/`.
+
+| READoc arXiv papers not used during development | Docs | Score |
+|---|---|---|
+| Section Anything `standard` (gpt-6-luna) | 905 | **70.0** |
+| Section Anything `quick` (gpt-6-luna) | 905 | 63.9 |
+| Section Anything `free` | 905 | 54.8 |
+| Docling 2.140 (heading hierarchy on) | 905 | 49.4 |
+
+On the 313 of those papers that MinerU's cloud service had processed: our `standard` 71.6,
+MinerU + its LLM title levels (gpt-6.1-sol) 67.2 (+4.4 for us, 95% CI 2.5 to 6.4), our `quick`
+66.1, MinerU cloud alone 57.3, Docling 49.2.
+
+On 1,112 bookmarked READoc GitHub READMEs not used in development, `free` scores 81.9 against
+Docling's 75.5. On 27 UK government reports never used in development (answer keys from each report's HTML version), the outline check improved `free` by +5.7 (95% CI +0.4 to +12.2; 43.1 → 48.8).
+
+Where others win: our `quick` and `standard` only tie with Docling on READMEs (about 75); Nougat, an OCR model trained on arXiv, scores far higher
+on arXiv papers (88.5, published).
+
+## Limitations
+
+- Reads the PDF's text layer. Scanned PDFs need OCR first.
+- Tables, figures and equations are not structured; their text is part of the section text.
+- `free` relies on bookmarks or a printed table of contents for its best results; without them it
+  is weaker than `quick` on papers. When the bookmarks look complete it drops headings they do not
+  list, so bookmarks that stop at the top levels lose real deeper headings (about 6% of READMEs
+  lose more than 5 points); set `SECTIONANY_DEMOTE_UNLISTED_HEADINGS='[]'` to turn this off.
+- `quick` and `standard` send text to the provider you configure; results vary slightly between
+  runs.
+- `local` uses Ollama's OpenAI-compatible endpoint, whose default context is small (4k tokens on
+  most laptops) and truncates silently. Candidate batches are kept small, but give the model a
+  larger context (for example a Modelfile with `num_ctx 8192`) for long documents. Quality with
+  local models has not been measured.
+- Python 3.11 or newer.
+
+## Licence
+
+Apache-2.0. See `LICENSE` and `NOTICE`.

section_anything-0.1.0/README.md

@@ -0,0 +1,182 @@
+# section-anything
+
+> **Pre-release (0.1).** The API may change before 1.0.
+
+Find the sections of a PDF: every heading, its level, the pages it spans and its exact
+character range in the extracted text. One call, with a dial from free rules to an LLM that
+reads the whole document, and a hard cost cap on every paid run.
+
+```python
+import section_anything
+
+tree = section_anything.section("paper.pdf", mode="quick")
+print(tree.to_markdown())
+# # A Study of Sectioning
+# ## 1 Introduction
+# ### 1.1 Scope
+# ## 2 Methods
+print(tree.sections[1])
+# {'number': '1', 'title': 'Introduction', 'level': 1, 'page_start': 1, 'page_end': 1,
+#  'start': 22, 'end': 484, 'flags': []}
+print(tree.summary())  # mode, model, pages, sections, calls, tokens, cost_usd, seconds
+```
+
+## Install
+
+Python 3.11+:
+
+```sh
+pip install section-anything
+pip install "section-anything[langfuse]"  # optional Langfuse tracing
+# latest from GitHub:
+pip install "git+https://github.com/Omniwot/section-anything#subdirectory=packages/section-anything"
+# from a checkout of the repository:
+pip install -e ./packages/section-anything
+```
+
+Dependencies: pdfplumber and pdfminer.six (MIT), pypdfium2 (Apache-2.0 / BSD-3-Clause),
+RapidFuzz (MIT), openai (Apache-2.0), pydantic and pydantic-settings (MIT). No PyMuPDF (AGPL).
+
+## Modes
+
+| Mode | What runs | Sent to a model | Cost per 1,000 pages |
+|---|---|---|---|
+| `free` (default) | PDF bookmarks or the printed table of contents as the outline, then typography and numbering rules; headings a complete-looking outline does not list are dropped | nothing | $0 |
+| `quick` | the rules propose candidate heading lines; a small model keeps the real ones and sets levels | candidate lines and a 70-character peek at the next line | about $0.07 (`gpt-6-luna`) |
+| `standard` | a model reads every line, with font hints, and marks where sections start and end | the document text | about $0.16 (`gpt-6-luna`), $2.90 (`gpt-6.1-sol`, the default) |
+| `local:<model>` | `quick`, answered by a local [Ollama](https://ollama.com) model | nothing leaves the machine | $0 |
+
+Costs are measured averages at the built-in list prices; your documents may differ.
+
+## Command line
+
+```sh
+section-anything paper.pdf                                   # free, Markdown headings
+section-anything paper.pdf --mode quick --format json        # JSON with spans and cost
+section-anything paper.pdf --mode standard --max-usd 0.5     # cap this document at $0.50
+section-anything paper.pdf --mode local:qwen3:4b --body      # headings plus section text
+```
+
+The result goes to stdout (or `-o FILE`), a one-line summary with the cost to stderr. Exit codes:
+0 done, 2 configuration (for example no API key), 3 refused by the cost cap, 4 the PDF could not
+be read. API keys are read from the environment only, never from the command line.
+
+## Output
+
+`tree.sections` is a list of dicts in reading order:
+
+| Key | Meaning |
+|---|---|
+| `number`, `title` | numbering as printed (`"2.3"`, `"Chapter 4"`, or `""`) and the heading text |
+| `level` | 1 = top level, 2 = its subsections, ... |
+| `page_start`, `page_end` | 1-based physical pages |
+| `start`, `end` | character range of the section's own text in `tree.text` (up to the next heading) |
+| `flags` | `doc_title` (the document's own title), `front_matter` (text before the first heading), `generated_title` (`standard` wrote a title for text that has no printed heading), and checks such as `start_marker_fuzzy`, `title_not_in_text`, `end_mismatch` |
+
+- `tree.to_markdown()`: the document title as `#`, every other heading as `#` x (level + 1),
+  capped at six. `to_markdown(body=True)` adds each section's text, reflowed into paragraphs,
+  with running headers and footers removed.
+- `tree.to_json()` / `tree.to_dict()`: the sections plus mode, model, pages, calls, tokens,
+  cost and any downgrades.
+- `tree.extraction` holds the lines with their boxes (PDF points), for highlighting.
+
+## Configuration
+
+Every setting can be passed in code or set as an environment variable `SECTIONANY_<NAME>`.
+Arguments win over the environment. **No `.env` file is read, and nothing is ever written to
+`os.environ`.**
+
+| Setting | Default | |
+|---|---|---|
+| `SECTIONANY_API_KEY` / `api_key=` | (none) | Falls back to `OPENAI_API_KEY` only while `base_url` is OpenAI's own endpoint |
+| `SECTIONANY_BASE_URL` / `base_url=` | `https://api.openai.com/v1` | Any OpenAI-compatible endpoint with JSON-schema outputs; always passed explicitly to the client |
+| `SECTIONANY_QUICK_MODEL`, `SECTIONANY_STANDARD_MODEL` / `model=` | `gpt-6-luna`, `gpt-6.1-sol` | |
+| `SECTIONANY_LOCAL_MODEL` | (none) | Ollama tag for `local` |
+| `SECTIONANY_OLLAMA_BASE_URL` | `http://localhost:11434/v1` | |
+| `SECTIONANY_PRICES` / `prices=` | built-in list | JSON `{"model": {"input": 2.0, "output": 10.0, "cached": 0.1}}`, USD per 1M tokens, merged over the built-in list |
+| `SECTIONANY_MAX_USD_PER_DOC` / `max_usd=` | `0.50` | hard per-document cap |
+| `SECTIONANY_OVER_BUDGET` / `over_budget=` | `downgrade` | or `fail` |
+| `SECTIONANY_MAX_PAGES`, `SECTIONANY_MAX_CHARS`, `SECTIONANY_MAX_MB` | 500, 5,000,000, 100 | refused above these |
+| `SECTIONANY_DEMOTE_UNLISTED_HEADINGS` / `demote_unlisted_headings=` | `["free"]` | modes in which sections that a complete-looking PDF outline does not list are dropped (JSON list; `[]` turns it off) |
+| `SECTIONANY_EXTRACT_TIMEOUT_SECONDS` / `extract_timeout=` | 120 | extraction worker is killed after this |
+| `SECTIONANY_EXTRACT_MEMORY_MB` | 4096 | worker memory limit (Linux only; 0 = none) |
+| `SECTIONANY_ISOLATE_EXTRACTION` | `true` | run extraction in a separate process |
+| `SECTIONANY_DEMOTE_UNLISTED_HEADINGS` | `[]` (off) | JSON list of modes (`free`, `quick`, `standard`): when the PDF's bookmarks look complete, drop sections they do not list (`section_anything.outline_check`) |
+| `SECTIONANY_LLM_TIMEOUT_SECONDS`, `SECTIONANY_LOCAL_TIMEOUT_SECONDS` | 300, 600 | per model call |
+| `SECTIONANY_STORE_PROMPTS` | `false` | keep prompt text in call records passed to a `Usage(sink=...)` |
+| `SECTIONANY_LANGFUSE` | `false` | trace calls with Langfuse (needs the `langfuse` extra and Langfuse's own keys) |
+
+Or build a `Settings` object once: `section(pdf, "quick", settings=Settings(max_usd_per_doc=1.0))`.
+Async code can `await section_anything.asection(...)`.
+
+## Costs and caps
+
+- **Unknown prices are refused.** A cloud model with no price (built-in, `SECTIONANY_PRICES` or
+  `prices=`) is refused before the PDF is read, so the cap can always be enforced. Local models
+  are free.
+- **Estimate first.** Before a paid mode runs, its cost is estimated from the document. Over
+  `max_usd`, the run is downgraded (standard -> quick -> free) and the downgrade is reported in
+  `tree.downgraded`, or refused with `CostCapExceeded` when `over_budget="fail"`.
+- **Hard cap while running.** The cap is re-checked before every model call, and each call's
+  output tokens are limited to what the remaining budget can pay for. A downgrade continues the
+  same budget. The SDK's own retries are off; one retry on an unusable answer is counted.
+- The built-in prices are list prices from October 2026. Check your provider's prices and
+  override them with `SECTIONANY_PRICES`.
+
+## Handling untrusted PDFs
+
+- File size and page count are checked first, from the PDF's page tree, without parsing any
+  page content.
+- Text extraction runs in a separate Python process: the text size is counted (PDFium) before
+  layout analysis starts, the process is killed at the time limit, has a memory limit on Linux,
+  runs in an empty temporary directory, and inherits no API keys. It returns JSON, not pickles.
+- Document text is treated as untrusted in every prompt; model output is validated against a
+  schema and clipped (strings to 300 characters, lists to 2,000 items). In `quick`, a heading
+  title the model rewrote is replaced by the printed line; in `standard`, titles the model wrote
+  for headingless text are flagged `generated_title`.
+- Log messages and errors name the error type, HTTP status and error code, never prompt or
+  response text.
+
+## Benchmarks (summary)
+
+Heading-tree similarity (TEDS, 0-100, higher is better) with
+[READoc](https://github.com/icip-cas/READoc)'s own scoring code, October 2026. The full tables,
+methods and per-document results are in the repository: `site/data/results.js` (rendered by the
+project site in `site/`) and `corpus/results/`.
+
+| READoc arXiv papers not used during development | Docs | Score |
+|---|---|---|
+| Section Anything `standard` (gpt-6-luna) | 905 | **70.0** |
+| Section Anything `quick` (gpt-6-luna) | 905 | 63.9 |
+| Section Anything `free` | 905 | 54.8 |
+| Docling 2.140 (heading hierarchy on) | 905 | 49.4 |
+
+On the 313 of those papers that MinerU's cloud service had processed: our `standard` 71.6,
+MinerU + its LLM title levels (gpt-6.1-sol) 67.2 (+4.4 for us, 95% CI 2.5 to 6.4), our `quick`
+66.1, MinerU cloud alone 57.3, Docling 49.2.
+
+On 1,112 bookmarked READoc GitHub READMEs not used in development, `free` scores 81.9 against
+Docling's 75.5. On 27 UK government reports never used in development (answer keys from each report's HTML version), the outline check improved `free` by +5.7 (95% CI +0.4 to +12.2; 43.1 → 48.8).
+
+Where others win: our `quick` and `standard` only tie with Docling on READMEs (about 75); Nougat, an OCR model trained on arXiv, scores far higher
+on arXiv papers (88.5, published).
+
+## Limitations
+
+- Reads the PDF's text layer. Scanned PDFs need OCR first.
+- Tables, figures and equations are not structured; their text is part of the section text.
+- `free` relies on bookmarks or a printed table of contents for its best results; without them it
+  is weaker than `quick` on papers. When the bookmarks look complete it drops headings they do not
+  list, so bookmarks that stop at the top levels lose real deeper headings (about 6% of READMEs
+  lose more than 5 points); set `SECTIONANY_DEMOTE_UNLISTED_HEADINGS='[]'` to turn this off.
+- `quick` and `standard` send text to the provider you configure; results vary slightly between
+  runs.
+- `local` uses Ollama's OpenAI-compatible endpoint, whose default context is small (4k tokens on
+  most laptops) and truncates silently. Candidate batches are kept small, but give the model a
+  larger context (for example a Modelfile with `num_ctx 8192`) for long documents. Quality with
+  local models has not been measured.
+- Python 3.11 or newer.
+
+## Licence
+
+Apache-2.0. See `LICENSE` and `NOTICE`.