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.1.tar.gz (3.7 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.1-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readpdfs-0.1.1.tar.gz
  • Upload date:
  • Size: 3.7 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.1.tar.gz
Algorithm Hash digest
SHA256 0048c7bd560a66b8570692c07ed72afa4ff772d585ac4b1f5e437928b58bab99
MD5 e51cd2c74e1fa02a00196e1c584996c9
BLAKE2b-256 181730a609248bff1a3a494016badda741a170a9a2cd4df966e282f16627f9c9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readpdfs-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.9 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3ef5c45c2ce0ce607dc928a0e1f293eb08a42bb4f17f9d319c7f6c87812c59a8
MD5 9f2a3f737a8926b6733e35edb013c587
BLAKE2b-256 104f6a8094df56f251721e1a0a6c310f937577c5b3236995367c0cdd73e25e78

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