Metadata-Version: 2.1
Name: pretty-jupyter
Version: 2.0.0
Summary: Exports Jupyter notebook into beautiful and dynamic HTML report.
Author: Jan Palasek
License: GPLv3
Project-URL: Source, https://github.com/JanPalasek/pretty-jupyter
Project-URL: Bug Tracker, https://github.com/JanPalasek/pretty-jupyter/issues
Project-URL: CI, https://github.com/JanPalasek/pretty-jupyter/actions
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Jupyter
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md

<h1 align="center">
  <br>
  Pretty Jupyter
  </br>
</h1>
<h4 align="center">Simple package for beautiful & dynamic reports</h4>

<p align="center">
  <a href="https://github.com/JanPalasek/pretty-jupyter/actions/workflows/ci.yml"><img src="https://github.com/JanPalasek/pretty-jupyter/actions/workflows/ci.yml/badge.svg" /></a>
  <a href="https://pypi.org/project/pretty-jupyter/"><img src="https://img.shields.io/github/v/release/JanPalasek/pretty-jupyter" /></a>
  <a href='https://pretty-jupyter.readthedocs.io/en/latest/?badge=latest'><img src='https://readthedocs.org/projects/pretty-jupyter/badge/?version=latest' alt='Documentation Status' />
</a>
</p>

<p align="center">
  <img src="docs/demo.gif" alt="demo preview" width="70%" />
</p>

## Introduction

Pretty Jupyter is a package that creates beautifully styled and dynamic html webpage from Jupyter notebook.

Check out the **[demo](http://janpalasek.com/pretty-jupyter-example.html)** and compare it with the [default jupyter](http://janpalasek.com/classic-jupyter-example.html). You can try Pretty Jupyter [online](http://janpalasek.com/pretty-jupyter.html).

## Main Features

- :point_right: **Visually appealing styles**.
- :point_right: **Table of Contents** can be automatically generated.
- :point_right: Using **Python variables in Markdown**.
- :point_right: **Tabsets** for hiding section content behind clickable tabs.
- :point_right: **Code Folding**: Show/Hide code to filter out unnecessary content.
- :point_right: **Themes**: Selection from a wide variaty of available themes.
- :point_right: **Wide range of configuration options** with sensible defaults. 

All these features are integrated directly in the output html page. Therefore there is no need for an interpreter running in the backend.

## Installation

```sh
python -m pip install pretty-jupyter
```

## Usage

```sh
jupyter nbconvert --to html --template pj ${PATH_TO_IPYNB}
```

## Resources

- **[Documentation](https://pretty-jupyter.readthedocs.io/)**
- **[Examples](https://github.com/JanPalasek/pretty-jupyter-examples)**

## Credits

* **RMarkdown**: RMarkdown served as a great inspiration when making this package.
* **nbconvert**: Pretty Jupyter uses nbconvert underhood. Its great extendability allowed this project to be created.
