Skip to content

Commit

Permalink
Merge pull request #6 from rubenperezm/main
Browse files Browse the repository at this point in the history
Update Reana JupyterLab docs
  • Loading branch information
garciagenrique authored Aug 20, 2024
2 parents dde9b1f + 9fafb9f commit 61b1816
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 2 deletions.
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ List of contributors in alphabetical order:
- Elena Gazzarrini <[email protected]>
- Domenic Gosein <[email protected]>
- Giovanni Guerrieri <[email protected]>
- Ruben Perez Mercado <[email protected]>
7 changes: 6 additions & 1 deletion docs/extensions/reana-jupyterlab/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Reana JupyterLab Extension
[![Install dependencies and build](https://github.com/vre-hub/reana-jupyterlab-extension/actions/workflows/build-and-publish.yml/badge.svg)](https://github.com/vre-hub/reana-jupyterlab-extension/actions/workflows/build-and-publish.yml/badge.svg)
[![Test](https://github.com/vre-hub/reana-jupyterlab-extension/actions/workflows/test.yml/badge.svg)](https://github.com/vre-hub/reana-jupyterlab-extension/actions/workflows/test.yml/badge.svg)
[![codecov](https://codecov.io/gh/vre-hub/reana-jupyterlab-extension/graph/badge.svg?token=OLV3EOPYFI)](https://codecov.io/gh/vre-hub/reana-jupyterlab-extension)
[![Python Versions](https://img.shields.io/pypi/pyversions/reana-jupyterlab.svg)](https://pypi.org/project/reana-jupyterlab)
[![PyPI Version](https://img.shields.io/pypi/v/reana-jupyterlab.svg)](https://pypi.org/project/reana-jupyterlab)
[![Docs](https://img.shields.io/badge/Docs-VRE%20Hub-blue)](https://vre-hub.github.io/docs/extensions/reana-jupyterlab/)

Reana JupyterLab plugin provides a set of tools to interact with the [Reana](https://reanahub.io/) workflow management system from within JupyterLab.

**This project is currently in development and is subject to change.**
![](../../../images/reana-demo.gif)

## Requirements
- JupyterLab{'>=4'},{'<'}5
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jlpm run build

Install the extension
```bash
python -m pip install .
python -m pip install .[dev]
```

Enable the server extension
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ To install the extension, run the following command:
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]
```

## Docker image
It is possible to run the extension in a Docker container. To download and run the image, use the following commands:
```bash
Expand Down
Binary file added images/reana-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 61b1816

Please sign in to comment.