nbless.main package

Submodules

nbless.main.nbconv module

nbless.main.nbconv.nbconv(nb_name: str, exporter: str = 'python') → Tuple[str, str][source]

Convert a notebook into various formats using nbformat exporters.

Parameters
  • input_name – The name of the input notebook.

  • exporter – The exporter that determines the output file type.

Note

The exporter type must be ‘asciidoc’, ‘pdf’, ‘html’, ‘latex’, ‘markdown’, ‘python’, ‘rst’, ‘script’, or ‘slides’. pdf requires latex, ‘notebook’ does nothing, slides need to served (not self-contained).

nbless.main.nbexec module

nbless.main.nbexec.nbexec(nb_name: str, kernel: str = 'python3') → Tuple[str, nbformat.notebooknode.NotebookNode][source]

Create an executed notebook without modifying the input notebook.

Parameters
  • nb_name – The NotebookNode object to be executed.

  • kernel – The programming language used to execute the notebook.

nbless.main.nbless module

nbless.main.nbless.nbless(filenames: List[str], kernel: str = 'python3') → nbformat.notebooknode.NotebookNode[source]

Create an executed Jupyter notebook from markdown and code files.

Parameters
  • filenames – A list of markdown and code file names.

  • kernel – The programming language used to run the notebook.

nbless.main.nbread module

nbless.main.nbread.nbread(filename: str) → nbformat.notebooknode.NotebookNode[source]

Read in a notebook file as an nbformat NotebookNode object.

Parameters

filename – The filename of the notebook to be read in.

nbless.main.nbsave module

nbless.main.nbsave.nbsave(filename: str, nb: nbformat.notebooknode.NotebookNode) → None[source]

Save an nbformat NotebookNode object as an ipynb file.

Parameters
  • filename – The filename of the output notebook.

  • nb – The NotebookNode object to be saved to a file.

nbless.main.nbuild module

nbless.main.nbuild.nbuild(filenames: List[str]) → nbformat.notebooknode.NotebookNode[source]

Create an unexecuted Jupyter notebook from markdown and code files.

Parameters

filenames – A list of source file names.

Module contents

Nbless: a Python package for programmatic Jupyter notebook workflows.