Skip to main content

Export Jupyter notebook into a pretty and dynamic HTML report.

Project description

Pretty Jupyter

Build

Pretty Jupyter is a package that creates beautifully styled and dynamic html webpage from Jupyter notebook. Check it yourself in our demo and compare it with the default jupyter.

All it takes to generate the output webpage are two simple commands, see installation and usage.

demo preview

Main Features

  • :point_right: Visually appealing styles.
  • :point_right: Automatic table of content's generation.
  • :point_right: Tabsets.
  • :point_right: Using Python variables in Markdown.
  • :point_right: Code folding.

Installation

python -m pip install pretty-jupyter

Usage

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

To unlock the full potential of Pretty Jupyter, see the customization section in the documentation.

Documentation

Dev Installation

git clone https://github.com/JanPalasek/pretty-jupyter.git
cd pretty-jupyter
./env/install.ps1 # Or sh env/install.sh on linux

Credits

Credits for styles, toc, tabs etc. go to developers of RMarkdown and its packages. A big part of this project is applying their incredible work to Jupyter. Credits also belong to nbconvert project.

Project details


Download files

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

Source Distribution

pretty-jupyter-1.2.1.tar.gz (2.2 MB view hashes)

Uploaded Source

Built Distribution

pretty_jupyter-1.2.1-py3-none-any.whl (4.3 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page