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 | |
| 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
- Full API reference: https://ocrqueen.com/docs
- Python SDK guide: https://ocrqueen.com/docs/sdks/python
- Data retention & deletion: https://ocrqueen.com/docs/data-retention
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ocrqueen-0.2.1.tar.gz.
File metadata
- Download URL: ocrqueen-0.2.1.tar.gz
- Upload date:
- Size: 65.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3d5821993b07f11dc2b1e90c6b062f9c18b3e1dc3ee1bceaa1a507371e15aa2a
|
|
| MD5 |
31d59bf083619a5e99349fd6ff229fca
|
|
| BLAKE2b-256 |
fbf1edbf6d48bad263b45c7c83fd2687aa0b17db8eae1df2cc9a123e2841f56c
|
Provenance
The following attestation bundles were made for ocrqueen-0.2.1.tar.gz:
Publisher:
release.yml on ocrqueen/ocrqueen-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ocrqueen-0.2.1.tar.gz -
Subject digest:
3d5821993b07f11dc2b1e90c6b062f9c18b3e1dc3ee1bceaa1a507371e15aa2a - Sigstore transparency entry: 1553015450
- Sigstore integration time:
-
Permalink:
ocrqueen/ocrqueen-python@a2e77cf52013d78ac261da03a59f45c336e0ea60 -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/ocrqueen
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a2e77cf52013d78ac261da03a59f45c336e0ea60 -
Trigger Event:
push
-
Statement type:
File details
Details for the file ocrqueen-0.2.1-py3-none-any.whl.
File metadata
- Download URL: ocrqueen-0.2.1-py3-none-any.whl
- Upload date:
- Size: 22.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e6198c30685de64a7dd0a81a5cbe3ad5507056eb32e4c82789d0b91552c87d60
|
|
| MD5 |
e78df8444e2c362aa6fc17fcf3e8248f
|
|
| BLAKE2b-256 |
fca23acdaacea85c3804c4b93632c8c159d640f29c6306787f584c7c823a1700
|
Provenance
The following attestation bundles were made for ocrqueen-0.2.1-py3-none-any.whl:
Publisher:
release.yml on ocrqueen/ocrqueen-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ocrqueen-0.2.1-py3-none-any.whl -
Subject digest:
e6198c30685de64a7dd0a81a5cbe3ad5507056eb32e4c82789d0b91552c87d60 - Sigstore transparency entry: 1553015455
- Sigstore integration time:
-
Permalink:
ocrqueen/ocrqueen-python@a2e77cf52013d78ac261da03a59f45c336e0ea60 -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/ocrqueen
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a2e77cf52013d78ac261da03a59f45c336e0ea60 -
Trigger Event:
push
-
Statement type: