# Jupyter Tasks
A collection of tasks for running Jupyter notebooks.
prefect.tasks.jupyter.jupyter.ExecuteNotebook(path=None, parameters=None, log_output=False, output_format="notebook", exporter_kwargs=None, kernel_name=None, **kwargs)[source]
Task for running Jupyter Notebooks. In order to parametrize the notebook, you need to mark the parameters cell as described in the papermill documentation: https://papermill.readthedocs.io/en/latest/usage-parameterize.html
path (string, optional): path to fetch the notebook from. Can be a cloud storage path. Can also be provided post-initialization by calling this task instance
parameters (dict, optional): dictionary of parameters to use for the notebook Can also be provided at runtime
log_output (bool): whether or not to log notebook cell output to the papermill logger.
output_format (str, optional): Notebook output format, should be a valid nbconvert Exporter name. 'json' is treated as 'notebook'. Valid exporter names: asciidoc, custom, html, latex, markdown, notebook, pdf, python, rst, script, slides, webpdf. (default: notebook)
exporter_kwargs (dict, optional): The arguments used for initializing the exporter.
kernel_name (string, optional): kernel name to run the notebook with. If not provided, the default kernel will be used.
**kwargs: additional keyword arguments to pass to the Task constructor
prefect.tasks.jupyter.jupyter.ExecuteNotebook.run(path=None, parameters=None, output_format=None, exporter_kwargs=None)[source]
Run a Jupyter notebook and output as HTML, notebook, or other formats.
This documentation was auto-generated from commit e6bd04a
on September 7, 2022 at 21:06 UTC