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.16-cp39-abi3-win_amd64.whl (1.5 MB view details)

Uploaded CPython 3.9+Windows x86-64

pyspoor-0.8.16-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.16-cp39-abi3-macosx_11_0_arm64.whl (1.5 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

pyspoor-0.8.16-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.16-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: pyspoor-0.8.16-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.16-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 3844a7d9739e87d42e37a8e99d492927b22c140eb2a016b57743e3a7cac4208c
MD5 25a3417886550da925c73cd9be047ec8
BLAKE2b-256 250a663e008c821917289e76787f163defa7c301008a5a3b1607b609d498a8d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyspoor-0.8.16-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.16-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for pyspoor-0.8.16-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 71e8466cb932a0f99938ce96185d359665a2be55a20f76ff9da550141deec432
MD5 0a069e8fdea3c43dedbb5d31fe799f59
BLAKE2b-256 cb064b8184711fd9228ce3a5b38b27074f566032d9622eb4f1e132f08262a015

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyspoor-0.8.16-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.16-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyspoor-0.8.16-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7c1dbaa8efd65a8de1f7b8075407ac0abbd6469f745b64490b4fdfa8a67ccc83
MD5 4410d7a1fa8d0e66bf74cb2e00f2154a
BLAKE2b-256 cee9e565b0c27769ad4fca7a665bd567d2d3d4a863bf9757909efa0d7987ab19

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyspoor-0.8.16-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.16-cp39-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for pyspoor-0.8.16-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 073a90a8f04e68ad5c2ceb2cabc29471358aff9dea5ea1683e018d5c4a6b4196
MD5 a9817913b86b10eec6139345bf502dcf
BLAKE2b-256 d329743faa3224758121e89c58979794d73456fae8ce15b94859aa4f094bafa0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyspoor-0.8.16-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