Quick generate HTML reports from your Jupyter Notebooks.
This is a lightweight Jupyter plugin that gives you the option to download
a report from the Jupyter Notebook interface. Upon installing, you get a
new button in the
Download as section that, when clicked, does the following
- Removes all empty cells
- Removes any cells with
hide_cellin the tags
- Removes the code of any cells with
hide_codein the tags
- Clears the
- Clears the input / output numbers
- Adds author / title information to the top of the page
- Outputs the notebook as a single HTML file that can be opened in the browser.
nbreport, first clone this repository to your computer, then run
pip install -e nbreport/
nbreport on your Jupyter environment with the following command:
jupyter bundlerextension enable --py nbreport --sys-prefix
There are two primary ways to use
As a command-line tool. You can invoke
nbreportfrom the command line with the following command:
It will output the HTML file in the same directory as the notebook you used as input.
From the Jupyter Notebook interface. From a live Notebook, you can convert the current notebook to an HTML report by following clicking on
File --> Download As --> NBReport. The HTML will be created in the same folder as the notebook you've opened.
You can expand the functionality of
nbreport with a few extra command-line options. For
--css parameter allows you to include arbitrary extra CSS files with your built
HTML, allowing you to style it however you like.