Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.37 KB
Raw

Contributing

We follow the Jupyter Contributing Guide.

Make sure to follow the Jupyter Code of Conduct.

Development install

A basic development install of IPython parallel is the same as almost all Python packages:

pip install -e .

To enable the server extension from a development install:

# for jupyterlab
jupyter server extension enable --sys-prefix ipyparallel
# for classic notebook
jupyter serverextension enable --sys-prefix ipyparallel

As described in the JupyterLab documentation for a development install of the jupyterlab extension you can run the following in this directory:

jlpm  # Install npm package dependencies
jlpm build  # Compile the TypeScript sources to Javascript
jupyter labextension develop . --overwrite  # Install the current directory as an extension

If you are working on the lab extension, you can run jupyterlab in dev mode to always rebuild and reload your extensions. In two terminals, run:

[term 1] $ jlpm watch
[term 2] $ jupyter lab --extensions-in-dev-mode

You should then be able to refresh the JupyterLab page and it will pick up the changes to the extension as you work.