You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: You will need NodeJS to install the extension for JupyterLab 2.x.
26
+
27
+
Developement install:
28
+
19
29
.. code:: bash
20
30
21
31
# Clone the repo to your local environment
22
32
# Move to jupyterlab-interactive-dashboard-editor directory
23
33
24
-
#Install dependencies
25
-
jlpm
26
-
#Build Typescript source
27
-
jlpm build
34
+
#Clone the repo to your local environment
35
+
# Change directory to the {{ cookiecutter.python_name }} directory
36
+
#Install package in development mode
37
+
pip install -e .
28
38
# Link your development version of the extension with JupyterLab
29
-
jupyter labextension install .
30
-
# Rebuild Typescript source after making changes
31
-
jlpm build
32
-
# Rebuild JupyterLab after making any changes
33
-
jupyter lab build
39
+
jupyter labextension develop . --overwrite
40
+
# Rebuild extension Typescript source after making changes
41
+
jlpm run build
42
+
34
43
35
-
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.
44
+
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.
36
45
37
46
.. code:: bash
38
47
39
-
# Watch the source directory in another terminal tab
40
-
jlpm watch
41
-
# Run jupyterlab in watch mode in one terminal tab
42
-
jupyter lab --watch
48
+
# Watch the source directory in one terminal, automatically rebuilding when needed
49
+
jlpm run watch
50
+
# Run JupyterLab in another terminal
51
+
jupyter lab
52
+
53
+
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).
54
+
55
+
By default, the `jlpm run build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
56
+
57
+
.. code:: bash
58
+
jupyter lab build --minimize=False
43
59
44
-
Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
0 commit comments