Giter VIP home page Giter VIP logo

html-reports's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.