otter-report 0.3.3

The simple HTML report generator for Python jobs.

Otter is a simple HTML report generator for Python jobs. Otter was designed to produce reports on long-running jobs on remote machines, and send them to a web server, but it’s able to process many different outputs from Python scripts, and convert them into neat and readible HTML pages.

Otter makes use of Twitter Bootstrap to make an easily themed layout for its output.

• Free software: ISC license

• Documentation: https://code.daniel-williams.co.uk/otter/

Quick Example

Otter can be used to produce reports containing a mixture of prose, data, and figures with minimal code.

This report was generated with just a small number of lines of Python:

import otter
import otter.bootstrap as bt

report = otter.Otter("index.html", author="Daniel Williams", title="Test Page", author_email= "[e-mail]")


with report:
    report + "#Section Title"

    report + "Lorem ipsum dolor sit amet..."


with report:

    row = bt.Row(3)

    import numpy as np
    import matplotlib.pyplot as plt

with report:
    f, ax = plt.subplots(1,1)
    x = np.linspace(0,10, 100)
    ax.plot(x, np.sin(x))

    row[1] + f

    row[0] + {"mass": "1kg", "price": "$1000", "area": 400}

    report + row

with report:
    report + "##Subsection Header"
    report + "Fusce vel lectus ultricies,... "

Features

• TODO Add support for pandas data tables

• TODO Add support for custom headers and footers

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-pypackage

History

0.0.1 (2016-01-30)

• First release on PyPI.

0.2.0 (2018-07-18)

“Beinn Dorain”

• New API for adding material to reports

• Full support for matplotlib plots

• Support for multiple data types in reports

0.3.0 (2020-03-02)

“Beinn an Dothaidh”

• Improved Python 3 support.

• Removed Python 2 support.