-
Couldn't load subscription status.
- Fork 1
fix: enhance installation instructions and improve backward compatibility #68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
6f365be
038f993
699e4f0
c82cf91
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,12 +20,12 @@ Reana JupyterLab plugin provides a set of tools to interact with the [Reana](htt | |
| ## Installation guide for users | ||
| To install the extension, run the following command: | ||
| ```bash | ||
| pip install reana-jupyterlab | ||
| python -m pip install reana-jupyterlab | ||
| ``` | ||
|
|
||
| In case you want to run the tests, install the extension with the following command: | ||
| ```bash | ||
| pip install reana-jupyterlab[dev] | ||
| python -m pip install reana-jupyterlab[dev] | ||
| ``` | ||
|
|
||
| ### Docker image | ||
|
|
@@ -52,17 +52,23 @@ Build the extension | |
| jlpm run build | ||
| ``` | ||
|
|
||
| Install the extension (including the testing dependencies) | ||
| Enable watch mode in a separate terminal to automatically rebuild the extension on changes: | ||
| ```bash | ||
| python -m pip install .[dev] | ||
| jlpm watch | ||
| ``` | ||
|
|
||
| Install the extension in editable mode and include the development dependencies: | ||
| ```bash | ||
| python -m pip install -e . | ||
| python -m pip install ".[dev]" | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would have run these commands in reverse order; first install all the requirements (including the Am I missing anything ? |
||
| ``` | ||
|
|
||
| Enable the server extension | ||
| ```bash | ||
| jupyter server extension enable --py reana_jupyterlab | ||
| python -m jupyter server extension enable --py reana_jupyterlab.server | ||
| ``` | ||
|
|
||
| Finally, open a JupyterLab instance. The extension should be available in the JupyterLab sidebar. | ||
| ```bash | ||
| jupyter lab | ||
| ``` | ||
| python -m jupyter lab --autoreload | ||
| ``` | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why should we remove the
python -mprefix here ?And add it on lines 62 and 68 ? (
python -m jupyter ...This command installs the extension within the "current" python environment, doesn't it ?