Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

The simple HTML report generator for Python jobs.

Project description

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.

Quick Example

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

images/screenshot.jpg

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= "daniel.williams@ligo.org")


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:

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for otter-report, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size otter_report-0.3.2-py2.py3-none-any.whl (16.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size otter-report-0.3.2.tar.gz (207.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page