Skip to main content

Official Python SDK for the DocRenders API

Project description

docrenders-sdk (Python)

Official Python SDK for the DocRenders API. No dependencies — uses the standard library only.

Installation

pip install docrenders-sdk

Usage

import os
from docrenders import DocRendersClient, RenderRequest, RenderFileRequest, RenderOptions

client = DocRendersClient(os.environ["PDFGEN_API_KEY"])

# Render to raw bytes
pdf = client.render(RenderRequest(
    markdown="# Invoice\n\nDue: **$1,200**",
    template="invoice",
    options=RenderOptions(format="A4"),
))

# Render and get a signed download URL (expires in 15 min)
result = client.render_signed_url(RenderRequest(markdown="# Report"))
print(result.url)

# Upload a file
with open("invoice.md", "rb") as f:
    pdf = client.render_file(RenderFileRequest(
        filename="invoice.md",
        content=f.read(),
    ))

# Check usage
usage = client.usage()
print(f"{usage.renders_used} / {usage.renders_limit} renders used")

Error handling

from docrenders import DocRendersClient, DocRendersError, RenderRequest

try:
    pdf = client.render(RenderRequest(markdown="# Hello"))
except DocRendersError as e:
    print(e.code, str(e))  # e.g. "quota_exceeded"

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

docrenders_sdk-0.1.0.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

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

docrenders_sdk-0.1.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docrenders_sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for docrenders_sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cbeceeb0a3ce4b53e7d0001de2fcdb44f43b7fe4f06b6a0815083fb70754c4eb
MD5 4a464bc2e6bb057ecc0d5e027eab97db
BLAKE2b-256 4045300cf4191c537e57de42fab12dc7659e0fe4246b4f597a49191b17cd7f3f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for docrenders_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac14d9a457df4e195f8f80801cb160b8b43b34f9251ee1b006189a43823ae683
MD5 d70bef8d0c0fdc24ed29100f066e0d16
BLAKE2b-256 5a47436f16b7072c0089961a839778f5e81fcc70dec75ebe32c7a00d2cbb560b

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