Jupyter Notebook Extension

Now you can commit your Jupyter Notebook to Jovian with just One Click. Make sure you’ve completed the Installation before reading further.

Using Jovian Jupyter Extension

jupyter extension toolbar button

Once you have successfully installed jovian, a new button Commit will appear on the tool bar. When using Commit button for first time you’ll be asked to provide an API key.

jovian api key prompt

You can get the API key at Jovian. Once you log in, just click on API key button, and the key will be copied to the clipboard.

jovian api key copy button

Valid API key

If the key is valid you will be notified with the following alert.

valid api key prompt

Error with API key

If the entered API key is invalid you will get following error.

api key error prompt

Successful Commit

Once the API key has been validated, you can start committing to Jovian by clicking Commit button. Once the Notebook has been committed successfully you will get the confirmation message with the link where the Jupyter Notebook has been uploaded to, you can use the copy button to get the link to the share the notebook.

jovian commit success prompt

Commit with more options

This makes use of jovian.commit’s parameters to enable the user to commit with preferences like private notebook, new notebook project, to add outputs and files …..

Step 1: click the dropdown menu

jovian dropdown menu

Step 2: choose commit with options

jovian commit options jupyter extension

Note: By default the parameters are derived from jovian.commit, changes to any parameter persists after commit.

Step 3: Click on Commit to commit the notebook with following options.

jupyter extension commit options prompt

Enable or Disable the extension

By default, the Jovian Jupyter Notebook Extension is enabled to the environment where jovian is installed.

You can also disable the extension by running the following command.

$ jovian disable-extension

To Enable the Notebook Extension, when you have manually disabled it.

$ jovian enable-extension