HTML Reports

Module for creating html reports based on jinja2 templates.

Usage

First you should create a report. Then you can add content to it. When you have all the content you can render it in a file with the write_report function.

For example:

from reports import Report

rep = Report()

rep.add_title("title1")
rep.add_title("title1.1", level=2)
rep.add_markdown("Some text")

rep.write_report()

This will create the report.html file using the templates/simple.html template.

Pyplot figures

Create a figure with pyplot and append it to the report with:

import matplotlib.pyplot as plt
plt.plot ([1, 2, 3]) 

rep.add_figure() 

Installation

pip install -r requirements.txt

Authors

• Arnau Villoro

License

The content of this repository is licensed under a MIT.

Nomenclature

Branches and commits use some prefixes to keep everything better organized.

Branches

• f/: features
• r/: releases
• h/: hotfixs

Commits

• [NEW] new features
• [FIX] fixes
• [REF] refactors
• [PYL] pylint improvements
• [TST] tests