.. _f-notebooktesthelper:

module ``automation.notebook_test_helper``
==========================================







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

module ``actuariat_python.automation.notebook_test_helper``

Some automation helpers to test notebooks and check they are still working fine.


:githublink:`%|py|6`






Functions
+++++++++

+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| function                                                                                                   | truncated documentation                                                                                |
+============================================================================================================+========================================================================================================+
| :func:`clean_function_notebook <actuariat_python.automation.notebook_test_helper.clean_function_notebook>` | Default cleaning for notebooks cells when unittesting.                                                 |
+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :func:`execute_notebooks <actuariat_python.automation.notebook_test_helper.execute_notebooks>`             | Executes a list of notebooks.                                                                          |
+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :func:`get_additional_paths <actuariat_python.automation.notebook_test_helper.get_additional_paths>`       | returns a list of paths to add before running the notebooks, paths to pyquickhelper, pyensae, pymmails |
+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :func:`ls_notebooks <actuariat_python.automation.notebook_test_helper.ls_notebooks>`                       | list the notebooks in a particular subfolder                                                           |
+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+








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

.. automodule:: actuariat_python.automation.notebook_test_helper
    :members:
    :special-members: __init__
    :show-inheritance: