Skip to main content

A Python client for the ReadPDFs API

Project description

ReadPDFs

A Python client for the ReadPDFs API that allows you to process PDF files and convert them to markdown.

Installation

pip install readpdfs

Usage

from readpdfs import ReadPDFs

# Initialize the client
client = ReadPDFs(api_key="your_api_key")

# Process a PDF from a URL
result = client.process_pdf(pdf_url="https://example.com/document.pdf")

# Process a local PDF file
result = client.process_pdf(file_path="path/to/local/document.pdf")

# Fetch markdown content
markdown = client.fetch_markdown(url="https://api.readpdfs.com/documents/123/markdown")

# Get user documents
documents = client.get_user_documents(clerk_id="user_123")

Features

  • Process PDFs from URLs or local files
  • Convert PDFs to markdown
  • Fetch markdown content
  • Retrieve user documents
  • Configurable processing quality

Requirements

  • Python 3.7+
  • requests library

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

readpdfs-0.1.2.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

readpdfs-0.1.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readpdfs-0.1.2.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.6

File hashes

Hashes for readpdfs-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b97070b5d45218fd618612ee2adf2f85dde9cabe03629ffaad22d62bc3e62605
MD5 602b9c4fb45e9e56912c53ae97f6c966
BLAKE2b-256 25de726baec53efd8974511043749050bfec05b4668a9d46cdff60ad9301aa5d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readpdfs-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.6

File hashes

Hashes for readpdfs-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6895263d69461bf9d7432e12d90502a9fe286d81325b432fbd33bbab8e95b3a6
MD5 68e299f2c8c9119d14f06880f875255c
BLAKE2b-256 515f9a0c59d041695ef0f05d52f381b2901e90a2eb35089388640b52ec393707

See more details on using hashes here.

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