CONTRIBUTING.md

Contributing

Welcome! As a Jupyter project, we follow the Jupyter contributor guide.

To setup a local development environment and ru tests, see the small section in the README.md file.

Local development setup

Python package

pip install -e .

# explicit install needed with editable mode (-e) jupyter
jupyter serverextension enable --sys-prefix jupyter_server_proxy

Before running tests, you need a notebook server that we can test against.

JUPYTER_TOKEN=secret jupyter-notebook --config=./tests/resources/jupyter_server_config.py

Run the tests:

pytest --verbose

JupyterLab extension

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm instead of jlpm below.

cd jupyterlab-server-proxy

# Install dependencies
jlpm

# Build Typescript source
jlpm build

# Link your development version of the extension with JupyterLab
jupyter labextension link .

# Rebuild Typescript source after making changes
jlpm build

# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch

# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch