File: CONTRIBUTING.md

package info (click to toggle)
ipyparallel 9.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,388 kB
  • sloc: python: 22,769; javascript: 267; makefile: 29; sh: 28
file content (44 lines) | stat: -rw-r--r-- 1,399 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Contributing

We follow the [Jupyter Contributing Guide](https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html).

Make sure to follow the [Jupyter Code of Conduct](https://jupyter.org/conduct/).

## Development install

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

```bash
pip install -e .
```

To enable the server extension from a development install:

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

As described in the [JupyterLab documentation](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html#developing-a-prebuilt-extension)
for a development install of the jupyterlab extension you can run the following in this directory:

```bash
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:

```bash
[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.