Skip to main content

Thin, dependency-free client for the paperparse scientific-PDF extraction service.

Project description

paperparse-client

A thin, dependency-free Python client for the paperparse service — turn a scientific-paper PDF into structured output (figures + captions + sub-panels, tables, equations, body markdown) from any backend, without pulling in paperparse's heavy dependencies or source.

pip install paperparse-client
from paperparse_client import PaperparseClient

pp = PaperparseClient(
    api_key="denario_live_...",          # a denario-web key (issue at denario-web.vercel.app)
    client_ref="skepthical:run_abc123",  # opaque per-run id — REQUIRED for B2B keys
)
res = pp.parse("paper.pdf", out_dir="run/")   # uploads, parses, downloads artifacts

print(res["title"], res["n_figures"], res["cost"]["cost_usd"])
for f in res["figures"]:
    print(f["label"], f["path"], f["caption"][:60])   # f["path"] = local PNG (out_dir set)
  • Stdlib only. No requests, no paperparse code — just an HTTP wrapper.
  • client_ref is required. An opaque identifier the caller generates (a run id or a user hash). It's used only for attribution (stamped on the service's trace); paperparse never inspects it. B2B API keys reject calls that omit it.
  • Async + robust. Uses the service's job flow (upload → run → poll), so a long parse survives a dropped connection.
  • out_dir downloads everything locally — document.md, figures.json, and each crop — and adds a local path to every figure/panel/table/equation in the result.

The result shape is documented in the paperparse repo's CONTRACT.md (versioned via schema_version). Upload is subject to the service's 32 MB request cap (papers are virtually always under it).

Project details


Download files

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

Source Distribution

paperparse_client-0.1.2.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

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

paperparse_client-0.1.2-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file paperparse_client-0.1.2.tar.gz.

File metadata

  • Download URL: paperparse_client-0.1.2.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for paperparse_client-0.1.2.tar.gz
Algorithm Hash digest
SHA256 927f2a9ce440dd2cf298790ab52f3db8ad0a6b094ac75375c63497c2434433fd
MD5 7f2df0779f7c1fbb62912e3208a2e609
BLAKE2b-256 253f55f28fba443f69739c9cc0d3aafd0740b4f5399a02c134c7ad7122338eba

See more details on using hashes here.

Provenance

The following attestation bundles were made for paperparse_client-0.1.2.tar.gz:

Publisher: publish-client.yml on borisbolliet/paperparse

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

File details

Details for the file paperparse_client-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for paperparse_client-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 774857f0daa5fdfa21db3a5bec3cdf44cfdbd33abd00929ae324158da53f970f
MD5 41645910b646117526b6c157a0d328cb
BLAKE2b-256 3d4daf15ab7a69571053ad17471d60833c4a67335d7901da890cd7ac74ed7b7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for paperparse_client-0.1.2-py3-none-any.whl:

Publisher: publish-client.yml on borisbolliet/paperparse

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