feat(pypi): add package readme and project URLs (0.2.2) (#148)
PyPI showed an empty description because pyproject.toml declared no readme. Point it at docs/python.md (refreshed with pip install now that wheels exist) and add sidebar URLs. Bump to 0.2.2 to republish. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Fable 5
parent
d7e697fc5e
commit
f3e3129a9a
+10
-2
@@ -1,9 +1,17 @@
|
|||||||
# Python API
|
# pdf-inspector
|
||||||
|
|
||||||
Python bindings via [PyO3](https://pyo3.rs). Requires Rust toolchain for building from source.
|
Fast PDF classification and text extraction. Detects whether a PDF is text-based or scanned, extracts text with position awareness, and converts to clean Markdown — all without OCR. Python bindings via [PyO3](https://pyo3.rs) for the [pdf-inspector](https://github.com/firecrawl/pdf-inspector) Rust library.
|
||||||
|
|
||||||
|
Built by [Firecrawl](https://firecrawl.dev) to handle text-based PDFs locally in under 200ms, skipping expensive OCR services for the ~54% of PDFs that don't need them.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install pdf-inspector
|
||||||
|
```
|
||||||
|
|
||||||
|
Prebuilt wheels cover CPython ≥3.8 on Linux (x86_64, aarch64), macOS (Intel, Apple Silicon), and Windows (x64). Other platforms build from source, which requires a Rust toolchain. For local development in a repo checkout:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install maturin
|
pip install maturin
|
||||||
maturin develop --release
|
maturin develop --release
|
||||||
|
|||||||
+7
-1
@@ -6,8 +6,9 @@ build-backend = "maturin"
|
|||||||
name = "pdf-inspector"
|
name = "pdf-inspector"
|
||||||
# Bump this to publish to PyPI — CI publishes automatically when the version
|
# Bump this to publish to PyPI — CI publishes automatically when the version
|
||||||
# changes on main (same flow as napi/package.json for npm).
|
# changes on main (same flow as napi/package.json for npm).
|
||||||
version = "0.2.1"
|
version = "0.2.2"
|
||||||
description = "Fast PDF inspection, classification, and text extraction with smart scanned vs text-based detection"
|
description = "Fast PDF inspection, classification, and text extraction with smart scanned vs text-based detection"
|
||||||
|
readme = "docs/python.md"
|
||||||
license = { text = "MIT" }
|
license = { text = "MIT" }
|
||||||
requires-python = ">=3.8"
|
requires-python = ">=3.8"
|
||||||
classifiers = [
|
classifiers = [
|
||||||
@@ -19,5 +20,10 @@ classifiers = [
|
|||||||
"Topic :: Text Processing",
|
"Topic :: Text Processing",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[project.urls]
|
||||||
|
Homepage = "https://github.com/firecrawl/pdf-inspector"
|
||||||
|
Repository = "https://github.com/firecrawl/pdf-inspector"
|
||||||
|
Documentation = "https://github.com/firecrawl/pdf-inspector/blob/main/docs/python.md"
|
||||||
|
|
||||||
[tool.maturin]
|
[tool.maturin]
|
||||||
features = ["python"]
|
features = ["python"]
|
||||||
|
|||||||
Reference in New Issue
Block a user