Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

49 lines (37 loc) · 1.7 KB

Contributing

Development install

Note: You will need Node.js to build the extension package.

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

# Clone the repo to your local environment
git clone https://github.com/jupyterlab-contrib/jupyter-suggestions.git
# Change directory to the jupytercad directory
cd jupyter-suggestions
# Install JupyterLab for jlpm
pip install jupyterlab
# Install dependencies
jlpm install
# Install package inde dev mode
jlpm dev
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

Development uninstall

pip uninstall jupyter-suggestions

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyter-suggestions within that folder.

Packaging the extension

See RELEASE