ReportLab Toolkit

4.4.10 · active · verified Sun Mar 29

The ReportLab Toolkit is an open-source Python library for generating high-quality PDF documents and graphics. It provides both low-level APIs for precise control over PDF elements and a higher-level framework (PLATYPUS) for creating complex, structured documents with flowables like paragraphs and tables. Currently at version 4.4.10, ReportLab is actively maintained with regular updates and is widely used for dynamic, data-driven report generation, including by Wikipedia for its 'Download as PDF' feature.

Warnings

breaking ReportLab 3.0 (released 2014) introduced significant internal rewrites for Python 3 compatibility and consistent Unicode/bytes handling. While API changes were minimized, older code might encounter unexpected behavior related to string encoding.
Fix: Review and update code for Python 3 compatibility, particularly regarding string types. Refer to ReportLab's change logs for detailed transitions.
breaking Reusing flowable objects (e.g., `Paragraph`, `Table`) in multiple document builds or pages without re-instantiating them can lead to `LayoutError` exceptions. ReportLab modifies these objects in place during the layout process, which is not reset for subsequent uses.
Fix: Always create new instances of flowable objects for each use, especially if generating multiple documents or repeating elements across different sections/pages. For example, `story.append(Paragraph('Text', styles['Normal']))` should be done for each paragraph, not defining `my_paragraph = Paragraph(...)` once and appending it multiple times.
gotcha The default coordinate system in ReportLab's `canvas` module has its origin (0,0) at the bottom-left corner of the page. This is different from many other graphics libraries where the origin is top-left, and can lead to incorrect positioning if not accounted for.
Fix: Always remember that y-coordinates increase upwards. Adjust calculations accordingly, or use helper functions/classes that abstract this if needed.
gotcha Optional C extensions (e.g., `rl_accel`, `rl_renderpm`) are crucial for optimal performance, especially with bitmap image processing and complex graphics. If these are not installed (often requiring a C compiler during `pip install`), ReportLab will fall back to slower pure-Python implementations or lack certain features.
Fix: Ensure that development tools including a C compiler (e.g., Build Tools for Visual Studio on Windows, Xcode Command Line Tools on macOS, `build-essential` on Linux) are installed before running `pip install reportlab` to allow compilation of optional C extensions. Verify installation by checking for performance or missing features.

Install

pip install reportlab Install stable version

Imports

SimpleDocTemplate

from reportlab.platypus import SimpleDocTemplate

Paragraph

from reportlab.platypus import Paragraph

getSampleStyleSheet

from reportlab.lib.styles import getSampleStyleSheet

letter

from reportlab.lib.pagesizes import letter

Canvas
```
from reportlab.pdfgen import canvas
```
pdfgen
```
from reportlab.pdfgen import canvas
```
Submodules like `pdfgen` or `pdfbase` are often not directly available under `reportlab` namespace after a simple import `reportlab`. Always import specific classes or submodules directly, e.g., `from reportlab.pdfgen import canvas`.

Quickstart

This quickstart demonstrates how to create a basic PDF document using ReportLab's higher-level PLATYPUS framework. It initializes a `SimpleDocTemplate`, defines a 'story' (a list of 'flowables' like `Paragraph` and `Spacer`), applies standard styles, and then builds the PDF.

from reportlab.platypus import SimpleDocTemplate, Paragraph, Spacer
from reportlab.lib.styles import getSampleStyleSheet
from reportlab.lib.pagesizes import letter

def create_pdf(filename="hello_reportlab.pdf"): 
    doc = SimpleDocTemplate(filename, pagesize=letter)
    styles = getSampleStyleSheet()
    story = []

    # Add a title
    story.append(Paragraph("Hello, ReportLab!", styles['h1']))
    story.append(Spacer(1, 0.2 * 25.4))

    # Add a paragraph
    long_text = "This is an example of a simple PDF document generated using the ReportLab Toolkit. It demonstrates how to use `SimpleDocTemplate` and `Paragraph` for basic text content. ReportLab provides extensive capabilities for layouts, tables, images, and graphics." 
    story.append(Paragraph(long_text, styles['Normal']))

    # Build the PDF document
    doc.build(story)
    print(f"PDF created: {filename}")

if __name__ == "__main__":
    create_pdf()

view raw JSON →