notebook_setup

Tools to setup and configure jupyter notebooks (ipynb files) with line and cell magic

Install

pip install notebook_setup

Usage

from notebook_setup import notebook_setup, notebook_config_plotly_rendering

Notebook setup

notebook_setup(autoreload=True, background_transparent=True)

autoreload=True ➜ runs this line magic:

%load_ext autoreload
%autoreload 2

background_transparent=True ➜ runs this cell magic:

%%html
<style>
.cell-output-ipywidget-background {background-color: transparent !important;}
.jp-OutputArea-output {background-color: transparent;}
</style>

Configure the behavior of Plotly figures in Jupyter notebooks

notebook_config_plotly_rendering(
    force_small_file=True, 
    global_renderer="svg",
    )

Only figures with fig.show() are effected by this configuration.

force_small_file=True ➜ Plotly figures are not saved inside the notebook

global_renderer: str ="available options" ➜ Specifies render format, has only effect if force_small_file=False

Configuration examples

Develop notebooks minimal file size, saves large notebooks very quickly:

notebook_config_plotly_rendering(
    force_small_file=True,
    global_renderer="svg",
    )

Export as html or push to GitHub small file size, vector or raster images depending on selected renderer

notebook_config_plotly_rendering(
    force_small_file=False, 
    global_renderer="svg",
    )

Archive notebooks on disk large file size, stores interactive figures, uses default renderer

notebook_config_plotly_rendering(
    force_small_file=False, 
    global_renderer=None,
    )

Configure individual figures independent of setting of global_renderer

fig.show(renderer="browser")

Hint: "browser" opens a figure in your web browser, you have bigger window compared to a notebook cell

1081 / notebook_setup