pretty-jupyter icon indicating copy to clipboard operation
pretty-jupyter copied to clipboard

Creates dynamic html report from jupyter notebook.


Pretty Jupyter

Simple package for beautiful & dynamic reports

Documentation Status

demo preview

Introduction

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

Check out the demo and compare it with the default jupyter. You can try Pretty Jupyter online.

Main Features

  • :point_right: Visually appealing styles.
  • :point_right: Automatic Table of Contents generation.
  • :point_right: Using Python variables in Markdown.
  • :point_right: Tabsets: Tabs that hold section content inside them.
  • :point_right: Code Folding: Show/Hide code to filter out unnecessary content.

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

Installation

python -m pip install pretty-jupyter

Usage

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

Documentation

Credits

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