pdf-reports 0.1.7

Create nice-looking PDF reports from HTML content.

PDF Reports is a Python library to create nice-looking PDF reports from HTML or Pug templates. It is used at the Edinburgh Genome Foundry to unify the look of web-generated reports across different libraries and services.

For instance your template template.pug may look like this (see a full example):

#sidebar I am the text in the sidebar.

h1 {{ title }}

.ui.piled.segment
  p Oh hi there ! I am some text in a cool box.

Your Python code will be as follows:

from pdf_reports import pug_to_html, write_report
html = pug_to_html("template.pug", title="My report")
write_report(html, "example.pdf")

And your final result may look like this (PDF file):

There is no documentation at the moment but since it is only two functions you can just have a look at their in-code documentation.

How it works

The library consists of just a few lines of Python, using pypugjs to parse Pug templates, optionally including stylesheets from the Semantic UI CSS framework, and finally calling weasyprint for PDF generation.

Importantly, because of the use of Semantic UI and the Lato font, pdf_reports currently requires an internet connection. It is also not the fastest report generator you will come accross, partly because it uses internet files.

Installation

You can install the library via PIP

sudo pip install pdf_reports

Alternatively, you can unzip the sources in a folder and type

sudo python setup.py install

Note: on some Debian systems you may need to first install libffi-dev (apt install libffi-dev).

License = MIT

This open-source software project was originally written at the Edinburgh Genome Foundry by Zulko and released on Github under the MIT licence (¢ Edinburg Genome Foundry). Everyone is welcome to contribute !