.. _f-runnotebook:

module ``ipythonhelper.run_notebook``
=====================================







Short summary
+++++++++++++

module ``pyquickhelper.ipythonhelper.run_notebook``

Functions to run notebooks.


:githublink:`%|py|5`






Functions
+++++++++

+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                               | truncated documentation                                                                                                       |
+========================================================================================================================+===============================================================================================================================+
| :func:`_cache_url_to_file <pyquickhelper.ipythonhelper.run_notebook._cache_url_to_file>`                               | Downloads file corresponding to url stored in *cache_urls*.                                                                   |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`_existing_dump <pyquickhelper.ipythonhelper.run_notebook._existing_dump>`                                       | Loads an existing dump.                                                                                                       |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`_get_dump_default_path <pyquickhelper.ipythonhelper.run_notebook._get_dump_default_path>`                       | Proposes a default location to dump results about notebooks execution.                                                        |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`badge_notebook_coverage <pyquickhelper.ipythonhelper.run_notebook.badge_notebook_coverage>`                     | Builds a badge reporting on the notebook coverage. It gives the proportion of run cells.                                      |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`execute_notebook_list <pyquickhelper.ipythonhelper.run_notebook.execute_notebook_list>`                         | Executes a list of notebooks.                                                                                                 |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`execute_notebook_list_finalize_ut <pyquickhelper.ipythonhelper.run_notebook.execute_notebook_list_finalize_ut>` | Checks the list of results and raises an exception if one failed. This is meant to be used in unit tests.                     |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_additional_paths <pyquickhelper.ipythonhelper.run_notebook.get_additional_paths>`                           | Returns a list of paths to add before running the notebooks for a given a list of modules.                                    |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`notebook_coverage <pyquickhelper.ipythonhelper.run_notebook.notebook_coverage>`                                 | Extracts a list of notebooks and merges with a list of runs dumped by function :func:`execute_notebook_list_finalize_ut`. ... |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`retrieve_notebooks_in_folder <pyquickhelper.ipythonhelper.run_notebook.retrieve_notebooks_in_folder>`           | Retrieves notebooks in a test folder.                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :func:`run_notebook <pyquickhelper.ipythonhelper.run_notebook.run_notebook>`                                           | Runs a notebook end to end, it is inspired from module `runipy <https://github.com/paulgb/runipy/>`_.                         |
+------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pyquickhelper.ipythonhelper.run_notebook
    :members:
    :special-members: __init__
    :show-inheritance: