File tree Expand file tree Collapse file tree 5 files changed +15
-40
lines changed Expand file tree Collapse file tree 5 files changed +15
-40
lines changed Original file line number Diff line number Diff line change 3737 matrix :
3838 python-version : ["3.8", "3.11"]
3939 jupyter_server-version : ["1", "2"]
40- jupyterlab-version : ["2", " 3"]
40+ jupyterlab-version : ["3"]
4141
4242 steps :
4343 - uses : actions/checkout@v3
@@ -109,20 +109,7 @@ jobs:
109109 jupyter server extension list
110110 jupyter server extension list 2>&1 | grep -iE "jupyter_server_proxy.*OK" -
111111
112- - name : Install JupyterLab Extension
113- if : matrix.jupyterlab-version == '2'
114- run : |
115- export NODE_OPTIONS=--openssl-legacy-provider
116- cd labextension
117- jupyter labextension install . --no-build --debug
118- jupyter lab build --minimize=False --debug
119-
120112 - name : Check the lab extension
121- # We test the labextension thoroughly in the acceptance tests below, so
122- # we have conditionally disabled this basic check is to avoid issues in
123- # jupyterlab.browser_check with jupyterlab 2 and jupyter_server 2+.
124- #
125- if : ${{ !(matrix.jupyterlab-version == '2' && matrix.jupyter_server-version != '1') }}
126113 run : |
127114 jupyter labextension list
128115 jupyter labextension list 2>&1 | grep -iE '@jupyterhub/jupyter-server-proxy.*OK.*'
Original file line number Diff line number Diff line change @@ -16,7 +16,7 @@ git clone https://github.com/jupyterhub/jupyter-server-proxy.git
1616cd jupyter-server-proxy
1717# Install package in development mode
1818pip install -e " .[test]"
19- # Link your development version of the extension with JupyterLab (only for JupyterLab 3)
19+ # Link your development version of the extension with JupyterLab
2020jupyter labextension develop --overwrite .
2121# Server extension must be manually installed in develop mode
2222jupyter server extension enable jupyter_server_proxy
Original file line number Diff line number Diff line change @@ -54,7 +54,7 @@ Server via the container.
5454
5555### Requirements
5656
57- - ` jupyterlab>=2 ` or ` notebook `
57+ Either ` jupyterlab>=3 ` or ` notebook<7 ` is required.
5858
5959### Python package
6060
@@ -70,22 +70,14 @@ pip install jupyter-server-proxy
7070conda install jupyter-server-proxy -c conda-forge
7171```
7272
73- #### Local development
74-
75- > See the [ contributing guide] ( https://github.com/jupyterhub/jupyter-server-proxy/blob/main/CONTRIBUTING.md ) .
76-
7773### JupyterLab extension
7874
79- Note that as the JupyterLab extension only is a graphical interface to
80- launch registered applications in the python package, the extension
81- requires the python package to be installed.
75+ A JupyterLab extension is bundled with the Python package to provide launch
76+ buttons in JupyterLab's Launcher panel for registered server processes.
8277
83- As of version 3.0.0 the Python package ships with a JupyterLab 3 compatible
84- extension, making this step only needed for JupyterLab 2.
78+ ![ ] ( docs/source/_static/images/labextension-launcher.png )
8579
86- ``` bash
87- jupyter labextension install @jupyterhub/jupyter-server-proxy
88- ```
80+ Clicking on them opens the proxied application in a new browser window.
8981
9082## Disable
9183
@@ -107,3 +99,7 @@ jupyter nbextension disable --sys-prefix --py jupyter_server_proxy
10799``` bash
108100jupyter labextension disable @jupyterhub/jupyter-server-proxy
109101```
102+
103+ #### Local development
104+
105+ To setup a local development environment, see the [ contributing guide] ( https://github.com/jupyterhub/jupyter-server-proxy/blob/main/CONTRIBUTING.md ) .
Original file line number Diff line number Diff line change @@ -17,20 +17,13 @@ is already running, it is reused.
1717
1818```
1919
20- ## JupyterLab Launcher Extension
20+ ## JupyterLab Extension
2121
22- The @jupyterhub/jupyter-server-proxy JupyterLab extension can be installed to
23- provide launcher icons for registered server processes.
24-
25- ``` bash
26- jupyter labextension install @jupyterhub/jupyter-server-proxy
27- ```
28-
29- This should provide icons for each registered process in the main
30- JupyterLab launcher
22+ A JupyterLab extension is bundled with the Python package to provide launch
23+ buttons in JupyterLab's Launcher panel for registered server processes.
3124
3225``` {image} _static/images/labextension-launcher.png
3326
3427```
3528
36- Clicking on them will open the application in a new window.
29+ Clicking on them opens the proxied application in a new browser window.
Original file line number Diff line number Diff line change @@ -30,7 +30,6 @@ requires-python = ">=3.8"
3030classifiers = [
3131 " Framework :: Jupyter" ,
3232 " Framework :: Jupyter :: JupyterLab" ,
33- " Framework :: Jupyter :: JupyterLab :: 2" ,
3433 " Framework :: Jupyter :: JupyterLab :: 3" ,
3534 " Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt" ,
3635 " Framework :: Jupyter :: JupyterLab :: Extensions" ,
You can’t perform that action at this time.
0 commit comments