Skip to content

Commit 2b024c3

Browse files
committed
Update readme with labextension info
1 parent d97223c commit 2b024c3

File tree

2 files changed

+60
-11
lines changed

2 files changed

+60
-11
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,6 @@
22
*.egg-info/
33
docs/_build
44
node_modules
5+
dist
6+
.vscode
7+
package-lock.json

README.rst

Lines changed: 57 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ Jupyter Server Proxy
2020
:target: https://www.npmjs.com/package/@jupyterlab/server-proxy
2121

2222
Jupyter Server Proxy lets you run arbitrary external processes (such
23-
as RStudio, Shiny Server, syncthing, PostgreSQL, etc) alongside your
24-
notebook, and provide authenticated web access to them.
23+
as RStudio, Shiny Server, Syncthing, PostgreSQL, Code Server, etc)
24+
alongside your notebook server and provide authenticated web access to
25+
them using a path like ``/rstudio`` next to others like ``/lab``.
26+
Alongside the python package that provides the main functionality, the
27+
JupyterLab extension (``@jupyterlab/server-proxy``) provides buttons
28+
in the JupyterLab launcher window to get to RStudio for example.
2529

2630
**Note:** This project used to be called **nbserverproxy**. As
2731
nbserverproxy is an older version of jupyter-server-proxy, uninstall
@@ -43,33 +47,75 @@ The primary use cases are:
4347
`The documentation <https://jupyter-server-proxy.readthedocs.io/>`_
4448
contains information on installation & usage.
4549

46-
====================
4750
Install
48-
====================
51+
=======
52+
53+
Python package
54+
--------------
4955

5056
pip
51-
---
57+
^^^
5258

5359
.. code-block::
5460
5561
pip install jupyter-server-proxy
5662
5763
conda
58-
-----
64+
^^^^^
5965

6066
.. code-block::
6167
6268
conda install jupyter-server-proxy -c conda-forge
6369
64-
src
65-
---
70+
JupyterLab extension
71+
--------------------
72+
73+
.. code-block::
74+
75+
jupyter labextension install @jupyterlab/server-proxy
76+
77+
Contributing
78+
============
79+
80+
Python package
81+
--------------
6682

6783
.. code-block::
6884
69-
pip install .
85+
pip install -e .
86+
87+
# explicit install needed with editable mode (``-e``) jupyter
88+
serverextension enable --sys-prefix jupyter_server_proxy
89+
90+
91+
JupyterLab extension
92+
--------------------
93+
94+
The ``jlpm`` command is JupyterLab's pinned version of ``yarn`` that
95+
is installed with JupyterLab. You may use ``yarn`` or ``npm`` instead
96+
of ``jlpm`` below.
97+
98+
.. code-block::
7099
71-
**Note:** if installing from source in editable mode: ``setup.py develop/pip install -e``, please explicitly install the server extensions:
100+
cd jupyterlab-server-proxy
101+
# Install dependencies
102+
jlpm
103+
# Build Typescript source
104+
jlpm build
105+
# Link your development version of the extension with JupyterLab
106+
jupyter labextension link .
107+
# Rebuild Typescript source after making changes
108+
jlpm build
109+
# Rebuild JupyterLab after making any changes
110+
jupyter lab build
111+
112+
You can watch the source directory and run JupyterLab in watch mode to
113+
watch for changes in the extension's source and automatically rebuild
114+
the extension and application.
72115

73116
.. code-block::
74117
75-
jupyter serverextension enable --sys-prefix jupyter_server_proxy
118+
# Watch the source directory in another terminal tab
119+
jlpm watch
120+
# Run jupyterlab in watch mode in one terminal tab
121+
jupyter lab --watch

0 commit comments

Comments
 (0)