pylopdf 0.4.1__tar.gz

pylopdf-0.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Yusuke Hayashi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pylopdf-0.4.1/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: pylopdf
+Version: 0.4.1
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT 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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+License-File: LICENSE
+Summary: PDF editing and rendering for Python, powered by Rust (lopdf + hayro). MIT, zero dependencies, lightweight wheels.
+Home-Page: https://github.com/yhay81/pylopdf
+Author-email: Yusuke Hayashi <yusuke8h@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+
+# pylopdf
+
+[日本語版 README はこちら](README.ja.md)
+
+PDF editing and rendering for Python, powered by Rust — [lopdf](https://github.com/J-F-Liu/lopdf) for editing and [hayro](https://github.com/LaurenzV/hayro) (the pure-Rust PDF renderer adopted by typst) for rendering.
+
+**MIT licensed, zero runtime dependencies, lightweight wheels.** Covers the common pymupdf use cases without the AGPL.
+
+## Why pylopdf?
+
+| | pylopdf | pymupdf | pypdf | pypdfium2 |
+|---|---|---|---|---|
+| License | **MIT** | AGPL / commercial | BSD | Apache/BSD |
+| Wheel size | **~3.5 MB** | ~40 MB+ | small (pure Python) | ~8 MB |
+| Editing (merge / split / metadata) | ✅ | ✅ | ✅ | limited |
+| Rendering (PNG / SVG) | ✅ | ✅ | ❌ | ✅ (PNG) |
+| Text extraction | ✅ (basic) | ✅ (advanced) | ✅ | ✅ |
+| Implementation | **pure Rust** | C | Python | C++ (PDFium) |
+
+- Fits size-constrained environments such as AWS Lambda
+- Safe for commercial projects that need to avoid the AGPL
+- abi3: one wheel covers Python 3.10–3.14
+- API modeled after [pymupdf](https://github.com/pymupdf/PyMuPDF)
+
+**Limitations**: no precise layout analysis, no annotation/form editing, no encrypted PDFs. Use pymupdf if you need those.
+
+## Install
+
+```bash
+pip install pylopdf  # (after PyPI release)
+```
+
+Building from source (requires a Rust toolchain):
+
+```bash
+uv sync
+```
+
+## Usage
+
+```python
+import pylopdf
+
+# Open from a path or bytes
+doc = pylopdf.open("input.pdf")
+doc = pylopdf.open(stream=pdf_bytes)
+
+# Page count
+print(doc.page_count)  # same as len(doc)
+
+# Metadata
+print(doc.metadata["title"])
+doc.set_metadata({"title": "Monthly Report", "author": "Alice"})
+
+# Text extraction (0-based page numbers)
+text = doc.get_page_text(0)
+
+# Rendering
+png: bytes = doc.render_page(0)             # 72 dpi
+png2x: bytes = doc.render_page(0, scale=2)  # 144 dpi
+svg: str = doc.render_page_svg(0)
+
+# Delete pages (split)
+doc.delete_page(0)
+doc.delete_pages([1, 2])
+
+# Keep/reorder pages
+doc.select([2, 0])
+
+# Merge
+merged = pylopdf.Document()
+merged.insert_pdf(pylopdf.open("a.pdf"))
+merged.insert_pdf(pylopdf.open("b.pdf"))
+
+# Save
+merged.save("merged.pdf")
+data: bytes = merged.tobytes()
+
+# Context manager
+with pylopdf.open("input.pdf") as doc:
+    print(doc.metadata)
+```
+
+## API
+
+`pylopdf.Document` (`pylopdf.open()` is an alias constructor):
+
+| Method / property | Description |
+|---|---|
+| `Document(filename=None, stream=None)` | Open from a path or bytes; empty document if both are None |
+| `page_count` / `len(doc)` | Number of pages |
+| `metadata` | Metadata dict (title, author, subject, keywords, creator, producer, creationDate, modDate, format) |
+| `set_metadata(dict)` | Set metadata (empty string deletes the entry) |
+| `get_page_text(pno)` | Extract text from a page |
+| `render_page(pno, scale=1.0)` | Render a page to PNG bytes |
+| `render_page_svg(pno)` | Render a page to an SVG string |
+| `select(page_numbers)` | Keep only the given pages, in the given order |
+| `delete_page(pno)` / `delete_pages(iterable)` | Delete pages |
+| `insert_pdf(other)` | Append all pages of another document |
+| `save(filename)` / `tobytes()` | Save |
+| `close()` | Close (supports `with`) |
+
+For low-level access, use `pylopdf.pylopdf_core._Document` (a thin lopdf wrapper) directly.
+
+## Architecture
+
+Follows the division of labor in the 2026 Rust PDF ecosystem:
+
+```
+pylopdf.Document (Python, pymupdf-style API)
+   └─ _Document (PyO3)
+        ├─ lopdf 0.44   … editing: open → modify → save
+        └─ hayro 0.7    … rendering: PNG / SVG (standard fonts embedded)
+```
+
+```
+rust/          # PyO3 bindings
+src/pylopdf/   # Python high-level API
+tests/         # pytest (Rust behavior is verified through Python tests)
+```
+
+```bash
+uv sync                    # build + install dependencies
+uv run pytest              # tests
+uv run ruff check .        # lint
+uv run mypy src tests      # type check
+uv build --wheel           # build a wheel
+```
+
+`uv sync` detects Rust source changes and rebuilds automatically (via `tool.uv.cache-keys`).
+
+## License
+
+MIT (lopdf is MIT; hayro is MIT/Apache-2.0)
+

pylopdf-0.4.1/README.md

@@ -0,0 +1,134 @@
+# pylopdf
+
+[日本語版 README はこちら](README.ja.md)
+
+PDF editing and rendering for Python, powered by Rust — [lopdf](https://github.com/J-F-Liu/lopdf) for editing and [hayro](https://github.com/LaurenzV/hayro) (the pure-Rust PDF renderer adopted by typst) for rendering.
+
+**MIT licensed, zero runtime dependencies, lightweight wheels.** Covers the common pymupdf use cases without the AGPL.
+
+## Why pylopdf?
+
+| | pylopdf | pymupdf | pypdf | pypdfium2 |
+|---|---|---|---|---|
+| License | **MIT** | AGPL / commercial | BSD | Apache/BSD |
+| Wheel size | **~3.5 MB** | ~40 MB+ | small (pure Python) | ~8 MB |
+| Editing (merge / split / metadata) | ✅ | ✅ | ✅ | limited |
+| Rendering (PNG / SVG) | ✅ | ✅ | ❌ | ✅ (PNG) |
+| Text extraction | ✅ (basic) | ✅ (advanced) | ✅ | ✅ |
+| Implementation | **pure Rust** | C | Python | C++ (PDFium) |
+
+- Fits size-constrained environments such as AWS Lambda
+- Safe for commercial projects that need to avoid the AGPL
+- abi3: one wheel covers Python 3.10–3.14
+- API modeled after [pymupdf](https://github.com/pymupdf/PyMuPDF)
+
+**Limitations**: no precise layout analysis, no annotation/form editing, no encrypted PDFs. Use pymupdf if you need those.
+
+## Install
+
+```bash
+pip install pylopdf  # (after PyPI release)
+```
+
+Building from source (requires a Rust toolchain):
+
+```bash
+uv sync
+```
+
+## Usage
+
+```python
+import pylopdf
+
+# Open from a path or bytes
+doc = pylopdf.open("input.pdf")
+doc = pylopdf.open(stream=pdf_bytes)
+
+# Page count
+print(doc.page_count)  # same as len(doc)
+
+# Metadata
+print(doc.metadata["title"])
+doc.set_metadata({"title": "Monthly Report", "author": "Alice"})
+
+# Text extraction (0-based page numbers)
+text = doc.get_page_text(0)
+
+# Rendering
+png: bytes = doc.render_page(0)             # 72 dpi
+png2x: bytes = doc.render_page(0, scale=2)  # 144 dpi
+svg: str = doc.render_page_svg(0)
+
+# Delete pages (split)
+doc.delete_page(0)
+doc.delete_pages([1, 2])
+
+# Keep/reorder pages
+doc.select([2, 0])
+
+# Merge
+merged = pylopdf.Document()
+merged.insert_pdf(pylopdf.open("a.pdf"))
+merged.insert_pdf(pylopdf.open("b.pdf"))
+
+# Save
+merged.save("merged.pdf")
+data: bytes = merged.tobytes()
+
+# Context manager
+with pylopdf.open("input.pdf") as doc:
+    print(doc.metadata)
+```
+
+## API
+
+`pylopdf.Document` (`pylopdf.open()` is an alias constructor):
+
+| Method / property | Description |
+|---|---|
+| `Document(filename=None, stream=None)` | Open from a path or bytes; empty document if both are None |
+| `page_count` / `len(doc)` | Number of pages |
+| `metadata` | Metadata dict (title, author, subject, keywords, creator, producer, creationDate, modDate, format) |
+| `set_metadata(dict)` | Set metadata (empty string deletes the entry) |
+| `get_page_text(pno)` | Extract text from a page |
+| `render_page(pno, scale=1.0)` | Render a page to PNG bytes |
+| `render_page_svg(pno)` | Render a page to an SVG string |
+| `select(page_numbers)` | Keep only the given pages, in the given order |
+| `delete_page(pno)` / `delete_pages(iterable)` | Delete pages |
+| `insert_pdf(other)` | Append all pages of another document |
+| `save(filename)` / `tobytes()` | Save |
+| `close()` | Close (supports `with`) |
+
+For low-level access, use `pylopdf.pylopdf_core._Document` (a thin lopdf wrapper) directly.
+
+## Architecture
+
+Follows the division of labor in the 2026 Rust PDF ecosystem:
+
+```
+pylopdf.Document (Python, pymupdf-style API)
+   └─ _Document (PyO3)
+        ├─ lopdf 0.44   … editing: open → modify → save
+        └─ hayro 0.7    … rendering: PNG / SVG (standard fonts embedded)
+```
+
+```
+rust/          # PyO3 bindings
+src/pylopdf/   # Python high-level API
+tests/         # pytest (Rust behavior is verified through Python tests)
+```
+
+```bash
+uv sync                    # build + install dependencies
+uv run pytest              # tests
+uv run ruff check .        # lint
+uv run mypy src tests      # type check
+uv build --wheel           # build a wheel
+```
+
+`uv sync` detects Rust source changes and rebuilds automatically (via `tool.uv.cache-keys`).
+
+## License
+
+MIT (lopdf is MIT; hayro is MIT/Apache-2.0)

pylopdf-0.4.1/pyproject.toml

@@ -0,0 +1,82 @@
+[project]
+name = "pylopdf"
+version = "0.4.1"
+description = "PDF editing and rendering for Python, powered by Rust (lopdf + hayro). MIT, zero dependencies, lightweight wheels."
+authors = [{ "name" = "Yusuke Hayashi", "email" = "yusuke8h@gmail.com" }]
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+dependencies = []
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Rust",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+[build-system]
+requires = ["maturin>=1.14,<2.0"]
+build-backend = "maturin"
+
+[tool.maturin]
+manifest-path = "rust/Cargo.toml"
+python-source = "src"
+module-name = "pylopdf.pylopdf_core"
+features = ["pyo3/extension-module"]
+
+[dependency-groups]
+dev = [
+    "maturin>=1.14.1",
+    "mypy>=1.14",
+    "pre-commit>=4.6.1",
+    "pytest>=8.3",
+    "ruff>=0.9",
+]
+
+[tool.uv]
+# Rust ソース変更時に uv が拡張モジュールを再ビルドするためのキャッシュキー
+cache-keys = [
+    { file = "pyproject.toml" },
+    { file = "rust/Cargo.toml" },
+    { file = "rust/src/*.rs" },
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 120
+src = ["src"]
+target-version = "py310"
+# python/ と lambda_test/ は本ライブラリの対象外（別作業の同居ファイル）
+extend-exclude = ["python", "lambda_test"]
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "D100",
+    "D104",
+    # ruff format と競合するルール
+    "COM812",
+    "ISC001",
+    "D203",
+    "D213",
+    # 日本語ドキュメント方針（CLAUDE.md）と衝突するルール
+    "D400",   # 「。」を終端句読点と認識しない
+    "D415",   # 同上
+    "D403",   # 日本語文中の英単語先頭を大文字化してしまう
+    "RUF001", # 全角記号を ambiguous unicode として誤検出する
+    "RUF002",
+    "RUF003",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["INP001", "S101", "D103", "PLR2004", "TC003"]