12
12
You can install using ` pip ` :
13
13
14
14
``` bash
15
- pip install {{ cookiecutter.python_package_name }}
16
- ```
17
-
18
- Or if you use jupyterlab:
19
-
20
- ``` bash
21
- pip install {{ cookiecutter.python_package_name }}
22
- jupyter labextension install @jupyter-widgets/jupyterlab-manager
15
+ pip install {{ cookiecutter.python_package_name }}
23
16
```
24
17
25
18
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
26
19
the nbextension:
27
20
``` bash
28
- jupyter nbextension enable --py [--sys-prefix| --user| --system] {{ cookiecutter.python_package_name }}
21
+ jupyter nbextension enable --py [--sys-prefix| --user| --system] {{ cookiecutter.python_package_name }}
29
22
```
30
23
31
24
## Development Installation
@@ -40,11 +33,11 @@ When developing your extensions, you need to manually enable your extensions wit
40
33
notebook / lab frontend. For lab, this is done by the command:
41
34
42
35
```
43
- jupyter labextension install @jupyter-widgets/jupyterlab-manager --no-build
44
- jupyter labextension install .
36
+ jupyter labextension develop --overwrite .
37
+ npm run build
45
38
```
46
39
47
- For classic notebook, you can run:
40
+ For classic notebook, you need to run:
48
41
49
42
```
50
43
jupyter nbextension install --sys-prefix --symlink --overwrite --py {{ cookiecutter.python_package_name }}
@@ -58,13 +51,14 @@ of those flags here.
58
51
59
52
### How to see your changes
60
53
#### Typescript:
61
- To continuously monitor the project for changes and automatically trigger a rebuild, start Jupyter in watch mode:
62
- ``` bash
63
- jupyter lab --watch
64
- ```
65
- And in a separate session, begin watching the source directory for changes:
54
+ If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different
55
+ terminals to watch for changes in the extension's source and automatically rebuild the widget.
56
+
66
57
``` bash
58
+ # Watch the source directory in one terminal, automatically rebuilding when needed
67
59
npm run watch
60
+ # Run JupyterLab in another terminal
61
+ jupyter lab
68
62
```
69
63
70
64
After a change wait for the build to finish and then refresh your browser and the changes should take effect.
0 commit comments