Skip to main content

CardReport

Latest release PyPI version

What’s new

Build static reports in Python from cards, KPIs, charts and tables. Compose a report, then get standalone HTML or PDF bytes for your application. PDF text is selectable and charts are vector graphics.

Reports in practice

These are images of PDFs produced by the library, not design mockups.

Operations dashboard — large KPIs, compact line charts and a color-coded ranking. Snapshot values come from an operations dashboard screenshot; trends are explicitly synthetic demonstration data. Python, template and datasets.

Operations dashboard rendered by CardReport

Spanish campaign report — the reference report with localized dates/numbers, tables and charts. Example and provenance.

Spanish campaign report rendered by CardReport

Install in your project

Python 3.12+ is required. Install from PyPI with uv, then install the PDF browser runtime:

uv add "cardreport[pdf]"
uv run python -m playwright install chromium

Keep your application’s uv.lock to pin the installed version. For HTML-only use, omit [pdf] and the browser-install command. See installation and quickstart for local checkouts, wheels and how to embed exports.

Use from Python

from cardreport import BarChart, Card, KPI, Report

report = Report("Call results")
report.add(Card(KPI("Total calls", 34)))
report.row(
    Card(BarChart(labels=["Answered", "No answer"], values=[24, 10])),
    height_mm=70,
)

html: str = report.to_html()
pdf: bytes = report.to_pdf()

Return pdf from your application, put it in storage, or use report.write_pdf("report.pdf") to save a file. Existing files are preserved by default. Reports reject content that does not fit rather than silently shrinking it.

Documentation

Chromium is the default renderer. The experimental SVG/WeasyPrint renderer works without JavaScript or a browser, with a smaller supported feature set. Both can render the original reference example. Local macOS/Python 3.12 is verified; Linux and Windows are not yet verified.

For architecture, decisions and contributing, see project documentation.

License

MIT. Bundled DejaVu fonts retain their font license. Third-party rendering packages retain their own licenses.

See language and display formats for report language tags, custom dates, number precision and the Spanish example.

Metadata

Release files for cardreport 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cardreport 0.4.0
File Size Uploaded Provenance Actions
cardreport-0.4.0.tar.gz 1.3 MB Without provenance Details for cardreport-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cardreport 0.4.0
File Interpreter ABI Platform Actions
cardreport-0.4.0-py3-none-any.whl Python 3 none any Details for cardreport-0.4.0-py3-none-any.whl

Total release size: 2.1 MB

Release files / cardreport-0.4.0.tar.gz

Download URL cardreport-0.4.0.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
1c7914f02eba53da93b5a9e4c1ff737b8b4f40697fdb011f11508d65ef3eaa25
BLAKE2b-256 checksum
How to use checksums
98496d2108769252dfa5ab2222d8c13b5f8b66dd402a64092f33383bdd4638f9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / cardreport-0.4.0-py3-none-any.whl

Download URL cardreport-0.4.0-py3-none-any.whl
Size 787.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dd8d9410977354ece4299898c2c045eda453a3320b4ff3bb30e3035237fc6971
BLAKE2b-256 checksum
How to use checksums
6b953ef1bc8a65cfed6d146591ae5527afe00607b1121426cfbe7a72f442a3e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for cardreport 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page