.. _f-notebookhelper: module ``ipythonhelper.notebook_helper`` ======================================== Short summary +++++++++++++ module ``pyquickhelper.ipythonhelper.notebook_helper`` Some automation helpers about notebooks :githublink:`%|py|5` Functions +++++++++ +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +=============================================================================================================================+=================================================================================================================================================================================================+ | :func:`find_notebook_kernel ` | Returns a dict mapping kernel names to resource directories. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_installed_notebook_extension ` | Retuns installed extensions. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_jupyter_datadir ` | Returns the data directory for the notebook. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_jupyter_extension_dir ` | Parameters ++++++++++ user : bool [default: False] Whether to check the user's .ipython/nbextensions directory. ... | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`get_notebook_kernel ` | Returns a `KernelSpec `_. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`install_jupyter_kernel ` | Installs a kernel based on executable (this python by default). | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`install_notebook_extension ` | Installs notebook extensions, see `install_nbextension `_ ... | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`install_python_kernel_for_unittest ` | Installs a kernel based on this python (sys.executable) for unit test purposes. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`read_nb ` | Reads a notebook and return a :class:`NotebookRunner` object. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`read_nb_json ` | Reads a notebook from a :epkg:`JSON` stream or string. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`remove_execution_number ` | Removes execution number from a notebook. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`remove_kernel ` | Removes a kernel. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`upgrade_notebook ` | Converts a notebook from version 2 to latest. | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :func:`writes ` | Write a notebook to a string in a given format in the current nbformat version. This function always writes the notebook ... | +-----------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.ipythonhelper.notebook_helper :members: :special-members: __init__ :show-inheritance: