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.0.tar.gz (3.6 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.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for readpdfs-0.1.0.tar.gz
Algorithm Hash digest
SHA256 350bce671f578bf5d6d35a2a72810f6874d797b0e17f1d87c45a362ff15e5844
MD5 3c08d3f497dc0e6eab8c0a6bbcbf1289
BLAKE2b-256 2c72142ab3e5db25be51623121386bb30f8643070a316ee1aae41a7790914180

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for readpdfs-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1d588d3f12b1ef4fa382274aae07075a9adb28a47ec4b56231115f42a7836094
MD5 97535467f6782ffd00b80202d3efce4c
BLAKE2b-256 7333430f06c76783bef36f59926a871b280dcc817b1dc24b96c83cfb458071f8

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