Skip to content

API Reference

Complete reference for every class, method, and parameter in quickthumb.

Public imports

from quickthumb import (
    Align,
    Background,
    BlendMode,
    Canvas,
    Diagnostic,
    Filter,
    FitMode,
    Glow,
    Grain,
    LinearGradient,
    RadialGradient,
    Shadow,
    Stroke,
    TextFillImage,
    TextPart,
    ValidationError,
)

Pages

Page What it covers
Canvas Canvas creation, layer builders, diagnostics, and export methods
Background .background() — solid colors, gradients, and images
Text .text() and TextPart — text layers and rich text
Image .image() — overlay images and cutouts
Shape .shape() — rectangles, ellipses, pills, triangles, stars, polygons
SVG .svg() — vector icons and logos rasterized at render time
Group .group() — auto-layout rows and columns
Outline .outline() — canvas border
Effects Stroke, Shadow, Glow, Filter, Background, Grain
Enums & Gradients Align, BlendMode, FitMode, LinearGradient, RadialGradient, TextFillImage

Error types

Exception When raised
ValidationError Invalid arguments passed to a layer builder (raised immediately)
RenderingError Failure during .render(), .to_base64(), or .to_data_url()