Skip to main content

Official Python SDK for the OCRQueen document extraction API

Project description

ocrqueen-python

Official Python SDK for the OCRQueen document and image extraction API.

🚧 Status: Pre-release. APIs and surface area will change before v1.0.0.

Installation

pip install ocrqueen

Requires Python 3.10 or newer.

Supported formats

Category Formats
Documents PDF
Presentations PPTX, PPT (PowerPoint)
Images PNG, JPEG, WebP, HEIC / HEIF (iPhone photos)

The API returns structured JSON + Markdown for every supported type — text, tables, images, and (with extraction_profile="advanced") diagram graph extraction and image alt-text.

Quickstart

from ocrqueen import OCRQueen

client = OCRQueen(api_key="pk_...")

with open("paper.pdf", "rb") as f:
    job = client.extract.create(file=f)

result = client.jobs.wait(job)
print(result.result["markdown"])

Get an API key from dashboard.ocrqueen.com.

Other file types

# Slide decks — speaker notes are preserved
job = client.extract.create(file=open("pitch.pptx", "rb"))

# iPhone photos — HEIC handled natively, no conversion needed
job = client.extract.create(file=open("receipt.heic", "rb"))

# Scanned document images
job = client.extract.create(file=open("invoice.png", "rb"))

# Deeper extraction profile — diagrams, image alt-text, OCR on
# embedded text
job = client.extract.create(
    file=open("patent.pdf", "rb"),
    profile="advanced",
)

Documentation

License

MIT — see LICENSE.

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

ocrqueen-0.3.0.tar.gz (67.6 kB view details)

Uploaded Source

Built Distribution

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

ocrqueen-0.3.0-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file ocrqueen-0.3.0.tar.gz.

File metadata

  • Download URL: ocrqueen-0.3.0.tar.gz
  • Upload date:
  • Size: 67.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ocrqueen-0.3.0.tar.gz
Algorithm Hash digest
SHA256 85dcd4dd69a03520dd664c3c57d2e0acd75600312126e0465476f1c21ea0a612
MD5 3786672e5dc81e6cbdb0137ab65b8e9b
BLAKE2b-256 7306f57dafea8349db1324c65431e6e77ff7a1b6e42fccf0ad884dd525a847e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for ocrqueen-0.3.0.tar.gz:

Publisher: release.yml on ocrqueen/ocrqueen-python

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

File details

Details for the file ocrqueen-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: ocrqueen-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ocrqueen-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d4726d8e1109d75809c57b6f43daded4160878a2248e03fc436d2eb21506e19e
MD5 d8767d24140f3a651bd3fe54ccda973a
BLAKE2b-256 d6ae3725a228ca859dfde1bafe7ffd9e5195257a4388cd48d7c3c80a40e96d2c

See more details on using hashes here.

Provenance

The following attestation bundles were made for ocrqueen-0.3.0-py3-none-any.whl:

Publisher: release.yml on ocrqueen/ocrqueen-python

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