Metadata-Version: 2.1
Name: esparto
Version: 0.2.5
Summary: Simple HTML and PDF document generator for Python.
Home-page: https://domvwt.github.io/esparto
License: MIT
Author: Dominic Thorn
Author-email: dominic.thorn@gmail.com
Requires-Python: >=3.6.1,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Provides-Extra: extras
Requires-Dist: Pillow (<9.0.0)
Requires-Dist: Pillow (>=7.0.0)
Requires-Dist: beautifulsoup4 (>=4.7); extra == "extras"
Requires-Dist: dataclasses; python_version < "3.7"
Requires-Dist: jinja2 (>=2.10.1,<3.0.0)
Requires-Dist: markdown (>=3.1,<4.0)
Requires-Dist: weasyprint (>=51); extra == "extras"
Project-URL: Repository, https://github.com/domvwt/esparto
Description-Content-Type: text/markdown

esparto
=======

[![image](https://img.shields.io/pypi/v/esparto.svg)](https://pypi.python.org/pypi/esparto)
[![Build Status](https://travis-ci.com/domvwt/esparto.svg?branch=main)](https://travis-ci.com/domvwt/esparto)
[![codecov](https://codecov.io/gh/domvwt/esparto/branch/main/graph/badge.svg?token=35J8NZCUYC)](https://codecov.io/gh/domvwt/esparto)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=domvwt_esparto&metric=alert_status)](https://sonarcloud.io/dashboard?id=domvwt_esparto)

Esparto is a simple HTML and PDF document generator for Python. Its primary use is for generating shareable single page reports
with content from popular analytics and data science libraries.

Full documentation and examples are available at [domvwt.github.io/esparto/](https://domvwt.github.io/esparto/).

## Overview
The library features a streamlined API that defines pages in terms of
sections, rows, and columns; and an intelligent wrapping system that automatically
converts Python objects into content.

We use the grid system and components from [Bootstrap](https://getbootstrap.com/) to ensure
documents adapt to the viewing device and appear immediately familiar and accessible.
No knowledge of Bootstrap or web development is required to use the library, however, as these
details are conveniently abstracted.

At publishing time, the completed document is passed to [Jinja2](https://palletsprojects.com/p/jinja/)
and fed into an HTML template with all style details and dependencies captured inline.

Esparto supports content rendering within Jupyter Notebooks, allowing users to interactively
and iteratively build documents without disrupting their workflow.

PDF conversion is provided by [Weasyprint](https://weasyprint.org/).

### Features
* Lightweight API
* No CSS or HTML required
* Device responsive display
* Self contained / inline dependencies
* Jupyter Notebook support
* Printer friendly formatting
* PDF output
* MIT License

### Supported Content
* Markdown
* Images
* Pandas DataFrames
* Plots from:
    * Matplotlib
    * Bokeh
    * Plotly

