prefect-jupyter

Welcome!

Prefect integrations interacting with Jupyter.

Getting Started

Python setup

Requires an installation of Python 3.7+.

We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.

These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the Prefect documentation.

Installation

Install prefect-jupyter with pip:

pip install prefect-jupyter

Run a parameterized notebook

prefect-jupyter uses papermill under the hood. Check out papermill's documentation to learn how to parametrize the notebook.

The following code shows how to run a parameterized notebook:

from prefect import flow
from prefect_jupyter import notebook

@flow
def example_execute_notebook():
    nb = notebook.execute_notebook(
        "test_notebook.ipynb",
        parameters={"num": 5}
    )
    body = notebook.export_notebook(nb)
    output_path = "executed_notebook.ipynb"
    with open(output_path, "w") as f:
        f.write(body)
    return output_path

example_execute_notebook()

Resources

If you encounter any bugs while using prefect-jupyter, feel free to open an issue in the prefect-jupyter repository.

If you have any questions or issues while using prefect-jupyter, you can find help in either the Prefect Discourse forum or the Prefect Slack community.

Feel free to ⭐️ or watch prefect-jupyter for updates too!

Development

If you'd like to install a version of prefect-jupyter for development, clone the repository and perform an editable install with pip:

git clone https://github.com/PrefectHQ/prefect-jupyter.git

cd prefect-jupyter/

pip install -e ".[dev]"

# Install linting pre-commit hooks
pre-commit install