Paperthin

About

Paperthin is a lightweight Python library to easily create HTML reports.

The idea is very simple:

• You provide various items to add to the report (plots, figures, tables...).
• Paperthin stitches them into a nicely formatted HTML report.
• You can then share the report with collaborators (no installations needed on their side).

Why use Paperthin over a plain Jupyter Notebook?

• As it is plain Python, it is very easy to automate (no papermill variable injection, takes care of the rendering).
• Minimal but clean formatting (sections, collapsible descriptions, rendering presets for many types of data).
• Embeds the data in the report and provides download buttons to retrieve it.
• Easy to inspect in git diffs (no need to learn Jupytext syntax).

Installation

pip install paperthin

Requires Python 3.12+.

Quick start

• Create a Report object
• Add Sections (graphical dividers) and Entry items with +
• Call report.make_report(path).

from matplotlib import pyplot as plt
from paperthin import Entry, Report, Section

fig, ax = plt.subplots()
ax.plot([1, 2, 3], [1, 4, 9])

report = (
    Report("My report")
    + Section("Plots")
    + Entry.plot(
        fig,
        title="Squares",
        info="A simple plot with its underlying data attached.",
    )
)

report.make_report("report.html")

This produces a single, self-contained report.html file you can open in a browser or send to anyone: no Python or Jupyter required on their end.

Documentation

Full documentation, including the list of built-in Entry types and how to create custom ones, is available at paperthin.readthedocs.io.

Citation

If paperthin is useful in your work, please consider citing the repo: https://github.com/StefanoCretti/paperthin

License

BSD-3-Clause. See LICENSE for details.