reportlab

ReportLab PDF Generation

Overview

ReportLab is a powerful Python library for programmatic PDF generation. Create anything from simple documents to complex reports with tables, charts, images, and interactive forms.

Two main approaches:

• Canvas API (low-level): Direct drawing with coordinate-based positioning - use for precise layouts
• Platypus (high-level): Flowing document layout with automatic page breaks - use for multi-page documents

Core capabilities:

• Text with rich formatting and custom fonts
• Tables with complex styling and cell spanning
• Charts (bar, line, pie, area, scatter)
• Barcodes and QR codes (Code128, EAN, QR, etc.)
• Images with transparency
• PDF features (links, bookmarks, forms, encryption)

Choosing the Right Approach

Use Canvas API when:

• Creating labels, business cards, certificates
• Precise positioning is critical (x, y coordinates)
• Single-page documents or simple layouts
• Drawing graphics, shapes, and custom designs
• Adding barcodes or QR codes at specific locations

Use Platypus when:

• Creating multi-page documents (reports, articles, books)
• Content should flow automatically across pages
• Need headers/footers that repeat on each page
• Working with paragraphs that can split across pages
• Building complex documents with table of contents

Use Both when:

• Complex reports need both flowing content AND precise positioning
• Adding headers/footers to Platypus documents (use onPage callback with Canvas)
• Embedding custom graphics (Canvas) within flowing documents (Platypus)

Quick Start Examples

Simple Canvas Document

from reportlab.pdfgen import canvas
from reportlab.lib.pagesizes import letter
from reportlab.lib.units import inch

c = canvas.Canvas("output.pdf", pagesize=letter)
width, height = letter

# Draw text
c.setFont("Helvetica-Bold", 24)
c.drawString(inch, height - inch, "Hello ReportLab!")

# Draw a rectangle
c.setFillColorRGB(0.2, 0.4, 0.8)
c.rect(inch, 5*inch, 4*inch, 2*inch, fill=1)

# Save
c.showPage()
c.save()