How-To: Import a Notebook from GitHub

Your data team has done work in Jupyter notebooks and uses GitHub for version control. You want to reuse this work in Dataiku Flows, while keeping the original source on GitHub. Learn how to import a notebook from GitHub.

You will need a Dataiku instance set up to work with git remotes.

From the +New Notebook menu of a the notebooks list in Dataiku, select Import from Git. Enter the URL of the repository (for example, https://github.com/jupyter/notebook/), the branch you want to pull from, and click List Notebooks.

Dataiku scans the repository for Jupyter notebooks and returns a list. Choose which ones you want and click Import.

A list of notebooks in a repository that can be imported

Note

Before running the notebook, look at the packages that the notebook code imports, and be sure to change the notebook kernel to associate it with a code environment that has those packages installed.

Best Practices for Notebook Development Between GitHub and Dataiku

You will notice that Dataiku allows you to push your changes to a notebook back to the external git repository. This offers a powerful opportunity to share development of the notebook between Dataiku users and those working outside Dataiku, but there are some best practices to be aware of.

Namely, Dataiku is not a conflict resolution program.

  • When you pull changes from the remote repository, local changes are overwritten by the remote.

  • When you push changes from Dataiku, changes on the remote are overwritten by the local.

So if you do want to share development of a notebook between GitHub and Dataiku, you should:

  • Create a branch on the git remote on which notebook development on Dataiku will occur.

  • Edit the notebook reference in Dataiku to use this branch.

  • Develop the notebook in Dataiku, then commit & push your changes to the remote repository.

  • In GitHub, merge this branch back into the main branch, resolving any conflicts.

Edit Notebook reference dialog

For further details, see the product documentation on importing notebooks from Git.