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

Uploaded CPython 3.9+Windows x86-64

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

Uploaded CPython 3.9+macOS 11.0+ ARM64

pyspoor-0.8.20-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.20-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: pyspoor-0.8.20-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.20-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 d5da1a33a49c22347c39d6905ae87221d05f5bb8ab8f23f0dd87b1c7f3572a9f
MD5 d59ef1f7dd9d810df838fe8d0a02bb03
BLAKE2b-256 b7f9bb3da73395a48983a038758a4cf3bf1568fbb319026a4b4fa494fc843ab8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for pyspoor-0.8.20-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a1019311d1275fab2639da880712f4c724ebea504703cff5e6996c9aaad46e84
MD5 434b1a430979f0ebfbdb84674cfe0613
BLAKE2b-256 5257875fd64e2372d286b451dc2b6d1e10f60ff456838bd3b65c25e9dfe7047e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for pyspoor-0.8.20-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0da9a536aafe31a9e8a972ab84f512e799a79cf35341c6601373cf37ef1a6f00
MD5 924d324c670407eba0500b3eb7f6b044
BLAKE2b-256 f236a81177d22fe5b2ccee2a94b33c8d58dc6f387e8c01f8c25475845c83f2ff

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for pyspoor-0.8.20-cp39-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e1b3a845cdbbaede2724bfdb3b83c025b09a69777888b3d3e3641a92a11f9c05
MD5 94ebb44ec6c1fe32533850b514cc015e
BLAKE2b-256 023965af319954e7193001e7ab93def62e604a9151251f8dad974ee40509a49c

See more details on using hashes here.

Provenance

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