Skip to main content

Python bindings for the deterministic spoor document engine

Project description

pyspoor

Typed Python adapter for spoor-core.

from spoor import parse_path

result = parse_path("report.pdf")
print(result.content.value.markdown)
for warning in result.warnings:
    print(warning["code"], warning.get("location"))

Agents must inspect result.warnings; a successful parse can still report a missing PDF text layer, suspicious text, merged-table degradation, or omitted visuals.

Tables: narrowing and pagination

For CSV/XLSX, parse_bytes / parse_path accept the same narrowing options as the CLI, so callers can page through full tables instead of the default 100-row preview:

from spoor import parse_bytes

# A slice by inclusive 1-based row range (mutually exclusive with limit/offset)
parse_bytes(data, source_name="data.xlsx", sheet="Sheet1", rows=(5, 104))

# Or paginate by limit/offset and keep only some columns
parse_bytes(data, source_name="data.xlsx", columns=["分类", "金额"], limit=100, offset=200)

PDFs: page ranges

For page-oriented PDFs, pass pages (inclusive 1-based) to parse only a slice and avoid reading a large document end to end:

parse_path("report.pdf", pages=(1, 3))  # only pages 1–3

Extracting embedded media

Resolve a safe media URI emitted in the output (DOCX images, extractable PDF images) to raw bytes for handing to an external vision model:

from spoor import extract_media

image = extract_media(data, "spoor://docx/part/word/media/image1.png", source_name="report.docx")

Build locally with maturin develop.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

pyspoor-0.8.13-cp39-abi3-win_amd64.whl (1.5 MB view details)

Uploaded CPython 3.9+Windows x86-64

pyspoor-0.8.13-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.17+ x86-64

pyspoor-0.8.13-cp39-abi3-macosx_11_0_arm64.whl (1.5 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

pyspoor-0.8.13-cp39-abi3-macosx_10_12_x86_64.whl (1.5 MB view details)

Uploaded CPython 3.9+macOS 10.12+ x86-64

File details

Details for the file pyspoor-0.8.13-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: pyspoor-0.8.13-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyspoor-0.8.13-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 5a938fc9afbf640877ecc21adeb49b5078eca6dd13273acef4b4ab1ac66cb35f
MD5 959acdb64e127063d12f415c40814288
BLAKE2b-256 02fed03cff6f53f28df484462849af16fd92fba1068925d14c32ae6be7996f5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyspoor-0.8.13-cp39-abi3-win_amd64.whl:

Publisher: release-bindings.yml on harrisonwang/spoor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyspoor-0.8.13-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pyspoor-0.8.13-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 8e6a8c5e34c76e66c41922a3bfb849aa0d624252641661897bfceac8b3c04800
MD5 eb6eba6b0bef749089a0f264c371dd01
BLAKE2b-256 b9052bc34b05ddd91f6a3033908fca219d7e510780a0ebbacf2d8af8058284b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyspoor-0.8.13-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release-bindings.yml on harrisonwang/spoor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyspoor-0.8.13-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyspoor-0.8.13-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 8672d4f3f34570d99c3d0942f1daaef975608f2f2ca81779a2800ae236b73285
MD5 054e545a48caa7aef36eec45c06d3e1f
BLAKE2b-256 db1f6a4c57368174432f7a5466edb20abb6403c83935cd7472756663ccd95d5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyspoor-0.8.13-cp39-abi3-macosx_11_0_arm64.whl:

Publisher: release-bindings.yml on harrisonwang/spoor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyspoor-0.8.13-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for pyspoor-0.8.13-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 96525e5be4a0d8538c4e337d1c1ff0b6eca6c903a0c3cff8bbbf0c482538b772
MD5 5b78b8c33ae174d78e87202c744ea8a2
BLAKE2b-256 096c55ac93cfd20d356b8eb37a15bd2fa56af7bcdb5315e0534abdf739074824

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyspoor-0.8.13-cp39-abi3-macosx_10_12_x86_64.whl:

Publisher: release-bindings.yml on harrisonwang/spoor

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page