pylabnotebook

Source code

PYLABNOTEBOOK This module is the main module where all the functions to run the cli of pylabnotebook are defined.

pylabnotebook.main.create_labnotebook(name: str) → None

Create new labnotebook.

This function creates a new labnotebook by creating a new .labnotebook folder with all the necessary files included.

Parameters:

name (str) – Name of the project.

pylabnotebook.main.export_labnotebook(output_file: str, force: bool, link: bool) → None

Export labnotebook to html.

This function exports the labnotebook into a single html file ready to read and share.

Parameters:

• output_file (str) – path of the file to create

• force (bool) – whether to force the overwriting of output_file if exists.

• link (bool) – whether to create links to analysis files in analysis files bullet list. These links can be used to open the analysis files directly from the notebook. # pylint: disable=line-too-long

pylabnotebook.main.update_labnotebook(force_update: bool) → None

Update labnotebook files.

This function updates body.html and config.json files in .labonotebook folder by looping through all commits not already inclded.

Parameters:

force_update (bool) – whether to force the update by starting from the beginning of the commit history. Mandatory if last commit in config.json is no more present in commit history (e.g. rebase, reset or any change in commit history) # pylint: disable=line-too-long