Installation#

Please Read This First#

Delivering LSP features to your JupyterLab requires three pieces:

1. jupyter-lsp#

  • runs in your jupyter_server application on your server to handle requests from the browser to language servers

  • to run, you need:

    • python >=3.7,<3.11.0a0

    • jupyter_server >=1.1.2

2. jupyterlab-lsp#

  • runs in your browser, as an extension to JupyterLab

  • to install it, you need:

    • jupyterlab >=3.3.0,<4.0.0a0

3. Language Servers#

  • run on your server

    • probably in another language runtime than python

  • some can be automatically detected if installed

  • others also need to be configured

Clean installation#

The approaches demonstrated below will ensure that correct versions of Python, JupyterLab and extensions are installed, and are generally recommended for novice users, or users who are not familiar with the Python ecosystem. However, if you feel proficient with using Python package managers such as pip and conda you may prefer to follow the custom installation guide instead, which allows to install the packages in an existing environment.

conda (minimal python)#

When installing from conda-forge, the jupyter-lsp-python bundle includes both the server extension (jupyter-lsp) and pyls (a third-party server also known as python-language-server). You can swap jupyter-lsp-python with another pre-made bundle, jupyter-lsp-r to get get the same server extension but with r-languageserver instead. Alternatively, you can install a language server of your choice manually (see further steps).

conda create -c conda-forge -n lsp 'python >=3.7,<3.11.0a0' 'jupyterlab=3.3.0' 'jupyterlab-lsp=4.0.0-alpha.0' 'jupyter-lsp-python=1.5.1'
conda activate lsp

Then run

jupyter lab

Your browser should open to your local server.

docker (data science)#

This approach is based roughly on the Jupyter docker-stacks documentation, which should be consulted for more about connecting volumes, passwords, and other advanced features:

Note: docker instructions were not updated for JupyterLab 3.0 and extension 3.0. Please consider submitting a PR to fix it.

Dockerfile#

# This already contains the python, r, julia, latex, and nodejs runtimes
FROM jupyter/datascience-notebook@sha256:73a577b006b496e1a1c02f5be432f4aab969c456881c4789e0df77c89a0a60c2

RUN conda install --quiet --yes --freeze-installed -c conda-forge \
    'python-language-server' \
    'jupyterlab=3.3.0' \
    'r-languageserver' \
    'texlab' \
    'chktex' \
    'jupyter-lsp=1.5.1' \
  && jupyter labextension install --no-build \
    '@jupyter-lsp/jupyterlab-lsp@4.0.0-alpha.0' \
  && jupyter lab build --dev-build=False --minimize=True \
  && conda clean --all -f -y \
  && rm -rf \
    $CONDA_DIR/share/jupyter/lab/staging \
    /home/$NB_USER/.cache/yarn \
  && fix-permissions $CONDA_DIR \
  && fix-permissions /home/$NB_USER

docker-compose.yml#

version: '2'

services:
  lsp-lab:
    build: .
    ports:
      - '18888:8888'

Build and Start#

docker-compose up

You should now be able to access http://localhost:18888/lab, using the token provided in the log.

Custom installation#

Get a working JupyterLab environment#

Refer to the official JupyterLab Installation Documentation for your installation approach.

pip

conda

pipenv

poetry

*

lab

lab

*

*

*

* PRs welcome!

Verify your lab works:

jupyter lab --version
jupyter lab

Install Jupyter[Lab] LSP#

conda#

conda install jupyterlab-lsp=4.0.0-alpha.0

pip#

pip install jupyterlab-lsp==4.0.0-alpha.0

Next step: Language Servers#

Now that you have jupyterlab-lsp, jupyter-lsp and all of their dependencies, you’ll need some language servers. See: