Module to create static html reports
Project description
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
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
html-reports-0.2.0.tar.gz
(3.9 kB
view hashes)
Built Distribution
Close
Hashes for html_reports-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eaf8cae221494f17724ba86297bec4b4e593ade910f3e6c130e02d9a04e15350 |
|
MD5 | dd272009df0580c9a9142505e5afc2a7 |
|
BLAKE2b-256 | aaf1fd69d1f80bc13e5ea364beacd6da217be4d5597ab17740addbae566249be |