https://github.com/JanPalasek/pretty-jupyter

Creates dynamic html report from jupyter notebook.
https://github.com/JanPalasek/pretty-jupyter

jupyter jupyter-notebook nbconvert notebook pretty-jupyter

Last synced: 2 months ago
JSON representation

Creates dynamic html report from jupyter notebook.

• Host: GitHub
• URL: https://github.com/JanPalasek/pretty-jupyter
• Owner: JanPalasek
• License: gpl-3.0
• Created: 2022-06-22T18:13:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-23T19:05:02.000Z (11 months ago)
• Last Synced: 2024-04-25T16:02:56.678Z (9 months ago)
• Topics: jupyter, jupyter-notebook, nbconvert, notebook, pretty-jupyter
• Language: Python
• Homepage: https://pretty-jupyter.readthedocs.io/
• Size: 14 MB
• Stars: 267
• Watchers: 5
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  


  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](https://janpalasek.com/projects/pretty-jupyter/pretty-jupyter-example.html)** and compare it with the [default jupyter](https://janpalasek.com/projects/pretty-jupyter/classic-jupyter-example.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.

- :point_right: **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

```sh

pip install pretty-jupyter

```

## Usage

```sh

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

```

## Resources

- **[Documentation](https://pretty-jupyter.readthedocs.io/)**

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

- **[Cheat Sheet](docs/cheatsheet/cheatsheet.pdf)**

## 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.