How to install the JupyterLab plugin

Kite's JupyterLab plugin currently has to be manually installed from the command line. This article provides instructions for doing so.

Requirements

  1. Make sure the Kite desktop app is installed. You can download it here.
  2. Kite's JupyterLab plugin requires a non-Docker installation of JupyterLab version 2.2 or later. Please visit the official docs to learn how to install, or upgrade to, the latest version of JupyterLab.
  3. JupyterLab requires Node.js to install extensions.

Installing the Plugin

Once the Kite desktop app and JupyterLab are installed, in the environment where JupyterLab is installed, run the following terminal commands:

pip install jupyter-kite
jupyter labextension install "@kiteco/jupyterlab-kite"

Updating the Plugin

We periodically ship updates to the JupyterLab plugin. Currently you need to manually update the plugin with terminal commands. To do so, stop the running JupyterLab process, then run the two commands:

pip install --upgrade jupyter-kite
jupyter labextension update "@kiteco/jupyterlab-kite"

Now you can restart JupyterLab and Kite will be updated.

Troubleshooting

If you are having issues installing Kite's JupyterLab plugin, first check that you have JupyterLab v2.2 or later, and that you have the Kite Engine application installed and running.

In addition, if you have the jupyterlab-lsp extension installed, you must disable it for Kite's plugin to work.

If you meet those requirements, then please open an issue in our issue tracker and provide the following information:

  • Your OS
  • Your browser console logs
  • Your terminal console output (as much of as possible, not just the first or final line)
  • The output of jupyter labextension list and jupyter serverextension list
  • The output of pip list
  • If you use conda, please share your environment

JupyterHub

If you use JupyterLab through a JupyterHub deployment within a workgroup, you can learn more about Kite's support for JupyterHub here.