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 build the extension package.
6
+
7
+
The `jlpm` command is JupyterLab's pinned version of
8
+
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
9
+
`yarn` or `npm` in lieu of `jlpm` below.
10
+
11
+
```bash
12
+
# Clone the repo to your local environment
13
+
# Change directory to the jupyter_ui_tweak directory
14
+
15
+
# Set up a virtual environment and install package in development mode
16
+
python -m venv .venv
17
+
source .venv/bin/activate
18
+
pip install --editable "."
19
+
20
+
# Link your development version of the extension with JupyterLab
21
+
jupyter labextension develop . --overwrite
22
+
23
+
# Rebuild extension Typescript source after making changes
24
+
# IMPORTANT: Unlike the steps above which are performed only once, do this step
25
+
# every time you make a change.
26
+
jlpm build
27
+
```
28
+
29
+
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.
30
+
31
+
```bash
32
+
# Watch the source directory in one terminal, automatically rebuilding when needed
33
+
jlpm watch
34
+
# Run JupyterLab in another terminal
35
+
jupyter lab
36
+
```
37
+
38
+
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).
39
+
40
+
By default, the `jlpm 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:
41
+
42
+
```bash
43
+
jupyter lab build --minimize=False
44
+
```
45
+
46
+
## Development uninstall
47
+
48
+
```bash
49
+
pip uninstall jupyter_ui_tweak
50
+
```
51
+
52
+
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
53
+
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
54
+
folder is located. Then you can remove the symlink named `jupyter-ui-tweak` within that folder.
A JupyterLab extension that tweaks the UI with the following features:
6
+
7
+
-**New dropdown menu** — Replaces the "New" dropdown button in the notebook tree view with one that lists available kernels sorted alphabetically by display name, instead of the default random order. Also includes shortcuts to create terminals, consoles, files, and directories.
8
+
-**Open in Voila** — Adds an "Open In Voila" command to the file browser context menu for `.ipynb` files, opening the selected notebook in [Voila](https://voila.readthedocs.io/).
6
9
7
10
## Requirements
8
11
@@ -26,58 +29,7 @@ pip uninstall jupyter_ui_tweak
26
29
27
30
## Contributing
28
31
29
-
### Development install
30
-
31
-
Note: You will need NodeJS to build the extension package.
32
-
33
-
The `jlpm` command is JupyterLab's pinned version of
34
-
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
35
-
`yarn` or `npm` in lieu of `jlpm` below.
36
-
37
-
```bash
38
-
# Clone the repo to your local environment
39
-
# Change directory to the jupyter_ui_tweak directory
40
-
41
-
# Set up a virtual environment and install package in development mode
42
-
python -m venv .venv
43
-
source .venv/bin/activate
44
-
pip install --editable "."
45
-
46
-
# Link your development version of the extension with JupyterLab
47
-
jupyter labextension develop . --overwrite
48
-
49
-
# Rebuild extension Typescript source after making changes
50
-
# IMPORTANT: Unlike the steps above which are performed only once, do this step
51
-
# every time you make a change.
52
-
jlpm build
53
-
```
54
-
55
-
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.
56
-
57
-
```bash
58
-
# Watch the source directory in one terminal, automatically rebuilding when needed
59
-
jlpm watch
60
-
# Run JupyterLab in another terminal
61
-
jupyter lab
62
-
```
63
-
64
-
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).
65
-
66
-
By default, the `jlpm 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:
67
-
68
-
```bash
69
-
jupyter lab build --minimize=False
70
-
```
71
-
72
-
### Development uninstall
73
-
74
-
```bash
75
-
pip uninstall jupyter_ui_tweak
76
-
```
77
-
78
-
In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
79
-
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
80
-
folder is located. Then you can remove the symlink named `jupyter-ui-tweak` within that folder.
32
+
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and contribution guidelines.
0 commit comments