-
Notifications
You must be signed in to change notification settings - 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
Open
tomondre
wants to merge
4
commits into
vre-hub:main
Choose a base branch
from
tomondre:fix-dev-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6f365be
fix: improve backward compatibility
tomondre 038f993
docs: enhance installation instructions
tomondre 699e4f0
docs: update JupyterLab command to include autoreload option
tomondre c82cf91
docs: add instructions to enable watch mode for automatic rebuilds
tomondre File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 ?