shenrun / pretty-jupyter

Creates dynamic html report from jupyter notebook.

Pretty Jupyter

Simple package for beautiful & dynamic reports

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.

Main Features

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

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

Installation

pip install pretty-jupyter

Usage

jupyter nbconvert --to html --template pj /path/to/ipynb/file

Resources

• Documentation
• Examples
• Cheat Sheet

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.