sopdf 0.1.0__tar.gz

sopdf-0.1.0/.gitignore

@@ -0,0 +1,52 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+MANIFEST
+
+# Testing & coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Type checking
+.mypy_cache/
+.ruff_cache/
+
+# Editors
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Windows
+Thumbs.db
+Desktop.ini
+
+# Temporary output from tests (render output, split pages, etc.)
+tests/output/
+
+# Build artifacts
+*.so
+*.dylib

sopdf-0.1.0/LICENSE

@@ -0,0 +1,183 @@
+                                 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 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, as submitted to the 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 designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and 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 the 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 any
+      Contribution embodied 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 in addition 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work,
+      and to permit persons to whom the Work is furnished to do so.
+
+   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, MERCHANTIBILITY, NON-INFRINGEMENT, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing 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 exemplary 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 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
+
+   Copyright 2025 Kevin Qiu
+
+   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.

sopdf-0.1.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: sopdf
+Version: 0.1.0
+Summary: A high-performance PDF processing library with a permissive license.
+Project-URL: Homepage, https://github.com/SoMarkAI/SoPDF
+Project-URL: Repository, https://github.com/SoMarkAI/SoPDF
+Project-URL: Bug Tracker, https://github.com/SoMarkAI/SoPDF/issues
+License: Apache-2.0
+License-File: LICENSE
+Keywords: document,pdf,pikepdf,pypdfium2,render,text-extraction
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.10
+Requires-Dist: pikepdf>=8.0
+Requires-Dist: pillow>=9.0
+Requires-Dist: pypdfium2>=4.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# SoPDF
+
+**The PDF processing library that belongs to everyone.**
+
+[![PyPI version](https://img.shields.io/pypi/v/sopdf.svg)](https://pypi.org/project/sopdf/)
+[![Python versions](https://img.shields.io/pypi/pyversions/sopdf.svg)](https://pypi.org/project/sopdf/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+
+```
+pip install sopdf
+```
+
+English | [中文](README_CN.md)
+
+</div>
+
+---
+
+## Why SoPDF?
+
+**1. 🚀 High Performance**
+
+With parallel processing and other optimizations, SoPDF significantly outperforms alternatives: rendering up to **1.56x faster**, plain text extraction **2.7x faster**, and full-text search **3x faster** — while maintaining **99% word-level accuracy consistency** with PyMuPDF. See the [Performance Benchmark](#performance-benchmark) section, or run it yourself.
+
+**2. ✨ Feature-Rich**
+
+Built on [`pypdfium2`](https://github.com/pypdfium2-team/pypdfium2) (Google PDFium, for rendering and text) and [`pikepdf`](https://github.com/pikepdf/pikepdf) (libqpdf, for structure and writing). SoPDF covers the entire workflow from rendering and text extraction to structural editing.
+
+**3. 🎯 Clean API**
+
+Intuition as documentation. You would have designed it the same way.
+
+**4. 🔓 Permissive License**
+
+In PDF processing, feature-rich + open source often comes with a license unfriendly to the open-source ecosystem. But SoPDF delivers equivalent core capabilities under the **Apache 2.0 License** — no strings attached, no license audit, zero friction. Embed it, ship it, fork it. It's yours.
+
+> If you find SoPDF helpful, please consider giving it a ⭐ Star — it really means a lot to us. Every star fuels our motivation to keep improving.
+
+---
+
+## Benchmarks
+
+> Measured on Apple M-series (arm64, 10-core), Python 3.10, against a 50-page PDF fixture.
+> Run the suite yourself: `python tests/benchmark/run_benchmarks.py`
+
+### Rendering vs PyMuPDF
+
+| Scenario | SoPDF | PyMuPDF | Speedup |
+| --- | --- | --- | --- |
+| Open document | 0.1 ms | 0.2 ms | **1.39× faster** |
+| Render 1 page @ 72 DPI | 6.6 ms | 9.1 ms | **1.38× faster** |
+| Render 1 page @ 150 DPI | 20.0 ms | 30.3 ms | **1.51× faster** |
+| Render 1 page @ 300 DPI | 64.6 ms | 101.1 ms | **1.56× faster** |
+| 50 pages sequential @ 150 DPI | 966.9 ms | 1470.3 ms | **1.52× faster** |
+| 50 pages parallel @ 150 DPI | 410.7 ms | 447.2 ms | **1.09× faster** |
+
+SoPDF wins at every DPI — and the margin widens at higher resolutions. In parallel mode, SoPDF achieves a genuine **2.35× speedup** over its own sequential baseline. PyMuPDF's thread-parallel path, on the other hand, actually *regresses* to 1548.9 ms (slower than sequential) because MuPDF serialises concurrent renders behind a global lock.
+
+### Text Extraction vs PyMuPDF
+
+| Scenario | SoPDF | PyMuPDF | Speedup |
+| --- | --- | --- | --- |
+| Plain text — 50 pages | 26.0 ms | 70.0 ms | **2.70× faster** |
+| Text blocks — 50 pages | 63.6 ms | 70.4 ms | **1.11× faster** |
+| Search 'benchmark' — 50 pages | 30.2 ms | 91.0 ms | **3.01× faster** |
+| Region extract — 50 pages | 27.6 ms | 39.6 ms | **1.43× faster** |
+
+Text search is the standout: **3× faster** than PyMuPDF. Plain-text extraction follows at **2.7×**. Correctness is verified — sopdf and PyMuPDF produce 99% word-level overlap on the same document, so the speed advantage carries no accuracy trade-off.
+
+---
+
+## Architecture
+
+SoPDF runs two best-in-class C/C++ engines in tandem:
+
+```
+┌──────────────────────────────────────────┐
+│               SoPDF Python API           │
+├───────────────────┬──────────────────────┤
+│   pypdfium2       │   pikepdf            │
+│   (Google PDFium) │   (libqpdf)          │
+│                   │                      │
+│   • Rendering     │   • Structure reads  │
+│   • Text extract  │   • All writes       │
+│   • Search        │   • Save / compress  │
+└───────────────────┴──────────────────────┘
+```
+
+A **dirty-flag + hot-reload** mechanism keeps the two engines in sync:
+when you write via pikepdf (e.g. rotate a page), the next read operation
+(e.g. render) automatically reserialises the document into pypdfium2 —
+zero manual sync required.
+
+Files are opened with **lazy loading / mmap** — a 500 MB PDF opens in
+milliseconds and only the pages you actually access are loaded.
+
+---
+
+## Quick Start
+
+```bash
+pip install sopdf
+```
+
+Requires Python 3.10+. The two native dependencies (`pypdfium2`, `pikepdf`) ship pre-built wheels for macOS, Linux, and Windows — no compiler needed.
+
+```python
+import sopdf
+
+# --- Open ---
+# from a file path (near-instant thanks to lazy loading & mmap)
+with sopdf.open("document.pdf") as doc:
+
+    # --- Render ---
+    img_bytes = doc[0].render(dpi=150)            # PNG bytes
+    doc[0].render_to_file("page0.png", dpi=300)   # write to disk
+
+    # parallel rendering across all pages
+    images = sopdf.render_pages(doc.pages, dpi=150, parallel=True)
+
+    # --- Extract text ---
+    text = doc[0].get_text()
+    blocks = doc[0].get_text_blocks()             # list[TextBlock] with bounding boxes
+
+    # --- Search ---
+    hits = doc[0].search("invoice", match_case=False)   # list[Rect]
+
+    # --- Split & merge ---
+    new_doc = doc.split(pages=[0, 1, 2], output="chapter1.pdf")
+    doc.split_each(output_dir="pages/")
+    sopdf.merge(["intro.pdf", "body.pdf"], output="book.pdf")
+
+    # --- Save ---
+    doc.append(new_doc)
+    doc.save("out.pdf", compress=True, garbage=True)
+    raw = doc.to_bytes()                          # no disk write
+
+    # --- Rotate ---
+    doc[0].rotation = 90
+
+# --- Encrypted PDFs ---
+with sopdf.open("protected.pdf", password="hunter2") as doc:
+    doc.save("unlocked.pdf")                      # encryption stripped on save
+
+# --- Open from bytes / stream ---
+with open("document.pdf", "rb") as f:
+    with sopdf.open(stream=f.read()) as doc:
+        print(doc.page_count)
+
+# --- Auto-repair corrupted PDFs ---
+with sopdf.open("corrupted.pdf") as doc:
+    doc.save("repaired.pdf")
+```
+
+---
+
+## Features
+
+| Capability | Examples |
+|---|---|
+| Open from path / bytes / stream | [01_open](examples/01_open) |
+| Render pages to PNG / JPEG | [02_render](examples/02_render) |
+| Batch & parallel rendering | [02_render](examples/02_render) |
+| Extract plain text | [03_extract_text](examples/03_extract_text) |
+| Extract text with bounding boxes | [03_extract_text](examples/03_extract_text) |
+| Full-text search with hit rects | [04_search_text](examples/04_search_text) |
+| Split pages into new document | [05_split](examples/05_split) |
+| Merge multiple PDFs | [06_merge](examples/06_merge) |
+| Save with compression | [07_save_compress](examples/07_save_compress) |
+| Serialise to bytes (no disk write) | [07_save_compress](examples/07_save_compress) |
+| Rotate pages | [08_rotate](examples/08_rotate) |
+| Open & save encrypted PDFs | [09_decrypt](examples/09_decrypt) |
+| Auto-repair corrupted PDFs | [10_repair](examples/10_repair) |
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).
+
+SoPDF is free to use in personal projects, commercial products, and open-source libraries. No licensing fees, no attribution requirements beyond the standard Apache 2.0 notice.
+
+## WeChat Group
+<img src="./docs/assets/wechat.png" width="100">

sopdf-0.1.0/README.md

@@ -0,0 +1,186 @@
+<div align="center">
+
+# SoPDF
+
+**The PDF processing library that belongs to everyone.**
+
+[![PyPI version](https://img.shields.io/pypi/v/sopdf.svg)](https://pypi.org/project/sopdf/)
+[![Python versions](https://img.shields.io/pypi/pyversions/sopdf.svg)](https://pypi.org/project/sopdf/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+
+```
+pip install sopdf
+```
+
+English | [中文](README_CN.md)
+
+</div>
+
+---
+
+## Why SoPDF?
+
+**1. 🚀 High Performance**
+
+With parallel processing and other optimizations, SoPDF significantly outperforms alternatives: rendering up to **1.56x faster**, plain text extraction **2.7x faster**, and full-text search **3x faster** — while maintaining **99% word-level accuracy consistency** with PyMuPDF. See the [Performance Benchmark](#performance-benchmark) section, or run it yourself.
+
+**2. ✨ Feature-Rich**
+
+Built on [`pypdfium2`](https://github.com/pypdfium2-team/pypdfium2) (Google PDFium, for rendering and text) and [`pikepdf`](https://github.com/pikepdf/pikepdf) (libqpdf, for structure and writing). SoPDF covers the entire workflow from rendering and text extraction to structural editing.
+
+**3. 🎯 Clean API**
+
+Intuition as documentation. You would have designed it the same way.
+
+**4. 🔓 Permissive License**
+
+In PDF processing, feature-rich + open source often comes with a license unfriendly to the open-source ecosystem. But SoPDF delivers equivalent core capabilities under the **Apache 2.0 License** — no strings attached, no license audit, zero friction. Embed it, ship it, fork it. It's yours.
+
+> If you find SoPDF helpful, please consider giving it a ⭐ Star — it really means a lot to us. Every star fuels our motivation to keep improving.
+
+---
+
+## Benchmarks
+
+> Measured on Apple M-series (arm64, 10-core), Python 3.10, against a 50-page PDF fixture.
+> Run the suite yourself: `python tests/benchmark/run_benchmarks.py`
+
+### Rendering vs PyMuPDF
+
+| Scenario | SoPDF | PyMuPDF | Speedup |
+| --- | --- | --- | --- |
+| Open document | 0.1 ms | 0.2 ms | **1.39× faster** |
+| Render 1 page @ 72 DPI | 6.6 ms | 9.1 ms | **1.38× faster** |
+| Render 1 page @ 150 DPI | 20.0 ms | 30.3 ms | **1.51× faster** |
+| Render 1 page @ 300 DPI | 64.6 ms | 101.1 ms | **1.56× faster** |
+| 50 pages sequential @ 150 DPI | 966.9 ms | 1470.3 ms | **1.52× faster** |
+| 50 pages parallel @ 150 DPI | 410.7 ms | 447.2 ms | **1.09× faster** |
+
+SoPDF wins at every DPI — and the margin widens at higher resolutions. In parallel mode, SoPDF achieves a genuine **2.35× speedup** over its own sequential baseline. PyMuPDF's thread-parallel path, on the other hand, actually *regresses* to 1548.9 ms (slower than sequential) because MuPDF serialises concurrent renders behind a global lock.
+
+### Text Extraction vs PyMuPDF
+
+| Scenario | SoPDF | PyMuPDF | Speedup |
+| --- | --- | --- | --- |
+| Plain text — 50 pages | 26.0 ms | 70.0 ms | **2.70× faster** |
+| Text blocks — 50 pages | 63.6 ms | 70.4 ms | **1.11× faster** |
+| Search 'benchmark' — 50 pages | 30.2 ms | 91.0 ms | **3.01× faster** |
+| Region extract — 50 pages | 27.6 ms | 39.6 ms | **1.43× faster** |
+
+Text search is the standout: **3× faster** than PyMuPDF. Plain-text extraction follows at **2.7×**. Correctness is verified — sopdf and PyMuPDF produce 99% word-level overlap on the same document, so the speed advantage carries no accuracy trade-off.
+
+---
+
+## Architecture
+
+SoPDF runs two best-in-class C/C++ engines in tandem:
+
+```
+┌──────────────────────────────────────────┐
+│               SoPDF Python API           │
+├───────────────────┬──────────────────────┤
+│   pypdfium2       │   pikepdf            │
+│   (Google PDFium) │   (libqpdf)          │
+│                   │                      │
+│   • Rendering     │   • Structure reads  │
+│   • Text extract  │   • All writes       │
+│   • Search        │   • Save / compress  │
+└───────────────────┴──────────────────────┘
+```
+
+A **dirty-flag + hot-reload** mechanism keeps the two engines in sync:
+when you write via pikepdf (e.g. rotate a page), the next read operation
+(e.g. render) automatically reserialises the document into pypdfium2 —
+zero manual sync required.
+
+Files are opened with **lazy loading / mmap** — a 500 MB PDF opens in
+milliseconds and only the pages you actually access are loaded.
+
+---
+
+## Quick Start
+
+```bash
+pip install sopdf
+```
+
+Requires Python 3.10+. The two native dependencies (`pypdfium2`, `pikepdf`) ship pre-built wheels for macOS, Linux, and Windows — no compiler needed.
+
+```python
+import sopdf
+
+# --- Open ---
+# from a file path (near-instant thanks to lazy loading & mmap)
+with sopdf.open("document.pdf") as doc:
+
+    # --- Render ---
+    img_bytes = doc[0].render(dpi=150)            # PNG bytes
+    doc[0].render_to_file("page0.png", dpi=300)   # write to disk
+
+    # parallel rendering across all pages
+    images = sopdf.render_pages(doc.pages, dpi=150, parallel=True)
+
+    # --- Extract text ---
+    text = doc[0].get_text()
+    blocks = doc[0].get_text_blocks()             # list[TextBlock] with bounding boxes
+
+    # --- Search ---
+    hits = doc[0].search("invoice", match_case=False)   # list[Rect]
+
+    # --- Split & merge ---
+    new_doc = doc.split(pages=[0, 1, 2], output="chapter1.pdf")
+    doc.split_each(output_dir="pages/")
+    sopdf.merge(["intro.pdf", "body.pdf"], output="book.pdf")
+
+    # --- Save ---
+    doc.append(new_doc)
+    doc.save("out.pdf", compress=True, garbage=True)
+    raw = doc.to_bytes()                          # no disk write
+
+    # --- Rotate ---
+    doc[0].rotation = 90
+
+# --- Encrypted PDFs ---
+with sopdf.open("protected.pdf", password="hunter2") as doc:
+    doc.save("unlocked.pdf")                      # encryption stripped on save
+
+# --- Open from bytes / stream ---
+with open("document.pdf", "rb") as f:
+    with sopdf.open(stream=f.read()) as doc:
+        print(doc.page_count)
+
+# --- Auto-repair corrupted PDFs ---
+with sopdf.open("corrupted.pdf") as doc:
+    doc.save("repaired.pdf")
+```
+
+---
+
+## Features
+
+| Capability | Examples |
+|---|---|
+| Open from path / bytes / stream | [01_open](examples/01_open) |
+| Render pages to PNG / JPEG | [02_render](examples/02_render) |
+| Batch & parallel rendering | [02_render](examples/02_render) |
+| Extract plain text | [03_extract_text](examples/03_extract_text) |
+| Extract text with bounding boxes | [03_extract_text](examples/03_extract_text) |
+| Full-text search with hit rects | [04_search_text](examples/04_search_text) |
+| Split pages into new document | [05_split](examples/05_split) |
+| Merge multiple PDFs | [06_merge](examples/06_merge) |
+| Save with compression | [07_save_compress](examples/07_save_compress) |
+| Serialise to bytes (no disk write) | [07_save_compress](examples/07_save_compress) |
+| Rotate pages | [08_rotate](examples/08_rotate) |
+| Open & save encrypted PDFs | [09_decrypt](examples/09_decrypt) |
+| Auto-repair corrupted PDFs | [10_repair](examples/10_repair) |
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).
+
+SoPDF is free to use in personal projects, commercial products, and open-source libraries. No licensing fees, no attribution requirements beyond the standard Apache 2.0 notice.
+
+## WeChat Group
+<img src="./docs/assets/wechat.png" width="100">