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

Uploaded CPython 3.9+Windows x86-64

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

Uploaded CPython 3.9+macOS 11.0+ ARM64

pyspoor-0.8.10-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.10-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: pyspoor-0.8.10-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.10-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 355c58c84fdd89ebac72de1311f9d5c8e7e4062c17c7dacedc3f9e76fc9e5ab5
MD5 5e8b5922e49d223859f2fda96d7550f3
BLAKE2b-256 dc1b192d982bfb615a856f2870257a33fe8b617f6991ef560ce995159af992dd

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for pyspoor-0.8.10-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1740a5823301058a609a3f0556dac35bacac6036b434b01884c756b81b56c767
MD5 1e0a1efc2fcc6ec65343381e2518ff3a
BLAKE2b-256 e9500ce916f545618f587807ee6c5b42ffa2ba3255f3705a182f9fdd5d6bf371

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for pyspoor-0.8.10-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 84190d505843fe7136ada5a95fe417c09fad740834bbd3544f39067f90512000
MD5 e043b395491523bd8e884fb449c0647b
BLAKE2b-256 f77ffcc082cd0b1c538ea1baaf76187a56f508c09a47eafe93bcdffe00d268a6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for pyspoor-0.8.10-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 462b41133655bbae87d5b91950829be7b6f97a6df5a793909e60ae12ec9a0ce2
MD5 5be20cec81b28ba17700f78df2596d87
BLAKE2b-256 f5ff7e010a64484ad0777628d4da3453293c02dd1e953663d2a1d0c13d8bcf49

See more details on using hashes here.

Provenance

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