Skip to content

Commit e32d36e

Browse files
committed
docs: enhance installation instructions and improve backward compatibility
1 parent 7389619 commit e32d36e

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ Reana JupyterLab plugin provides a set of tools to interact with the [Reana](htt
2020
## Installation guide for users
2121
To install the extension, run the following command:
2222
```bash
23-
pip install reana-jupyterlab
23+
python -m pip install reana-jupyterlab
2424
```
2525

2626
In case you want to run the tests, install the extension with the following command:
2727
```bash
28-
pip install reana-jupyterlab[dev]
28+
python -m pip install reana-jupyterlab[dev]
2929
```
3030

3131
### Docker image
@@ -52,17 +52,18 @@ Build the extension
5252
jlpm run build
5353
```
5454

55-
Install the extension (including the testing dependencies)
55+
Install the extension in editable mode and include the development dependencies:
5656
```bash
57-
python -m pip install .[dev]
57+
python -m pip install -e .
58+
python -m pip install ".[dev]"
5859
```
5960

6061
Enable the server extension
6162
```bash
62-
jupyter server extension enable --py reana_jupyterlab
63+
python -m jupyter server extension enable --py reana_jupyterlab.server
6364
```
6465

6566
Finally, open a JupyterLab instance. The extension should be available in the JupyterLab sidebar.
6667
```bash
67-
jupyter lab
68-
```
68+
python -m jupyter lab
69+
```

reana_jupyterlab/__init__.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,11 @@ def _jupyter_labextension_paths():
1818
def _jupyter_server_extension_points(): # pragma: no cover
1919
return [{
2020
"module": "reana_jupyterlab.server"
21-
}]
21+
}]
22+
23+
# Import and expose the server extension loading function for backward compatibility
24+
# Fixes `X Validation failed: validation failed` error
25+
26+
from .server import _load_jupyter_server_extension
27+
28+
load_jupyter_server_extension = _load_jupyter_server_extension

0 commit comments

Comments
 (0)