Prefect integrations interacting with Jupyter.
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.
Install prefect-jupyter
with pip
:
pip install prefect-jupyter
from prefect import flow
from prefect_jupyter import notebook
@flow
def example_execute_notebook():
body = notebook.execute_notebook(
"test_notebook.ipynb",
parameters={"num": 5}
)
output_path = "executed_notebook.ipynb"
with open(output_path, "w") as f:
f.write(body)
return output_path
example_execute_notebook()
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.
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