Skip to content

Commit add8168

Browse files
ptitzlerlresende
andauthored
Update repository readme and documentation with JupyterLab v4 information (#3145)
--------- Signed-off-by: Patrick Titzler <[email protected]> Signed-off-by: Luciano Resende <[email protected]> Co-authored-by: Luciano Resende <[email protected]>
1 parent 650d9e9 commit add8168

File tree

4 files changed

+53
-26
lines changed

4 files changed

+53
-26
lines changed

COMMITTERS.csv

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Name, Company, Github ID
2-
Alan Chin, IBM, akchinSTC
2+
Alan Chin, IBM, akchinSTC
33
Alex Bozarth, IBM, ajbozarth
44
Karla Spuldaro, IBM, karlaspuldaro
5-
Kevin Bates, IBM, kevin-bates
5+
Kevin Bates, , kevin-bates
66
Kiersten Stokes, IBM, kiersten-stokes
77
Luciano Resende, Apple , lresende
88
Martha Cryan, IBM, marthacryan

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,11 @@ Refer to the [installation documentation](https://elyra.readthedocs.io/en/stable
8686
For detailed information refer to the [installation documentation](https://elyra.readthedocs.io/en/stable/getting_started/installation.html).
8787

8888
### Prerequisites :
89-
* [Node.js 18+](https://nodejs.org/en/)
90-
* [Python 3.8+](https://www.python.org/downloads/)
91-
* [Miniconda](https://docs.conda.io/en/latest/miniconda.html) (optional)
89+
* [Node.js 20+](https://nodejs.org/en/)
90+
* [Python 3.9+](https://www.python.org/downloads/)
91+
* [Miniconda](https://docs.conda.io/en/latest/miniconda.html) / [Micromamba](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html) (optional)
9292

93-
### Install current release (for JupyterLab 3.x)
93+
### Install current release (for JupyterLab 4.x)
9494

9595
The current release version is displayed at the top of this page.
9696

@@ -110,6 +110,38 @@ The current release version is displayed at the top of this page.
110110

111111
Installation instructions and JupyterLab support vary by release. Note that a JupyterLab build is required. Installation instructions are located in the [release-specific documentation](https://elyra.readthedocs.io/en/stable/), which can be accessed by selecting a specific version.
112112

113+
<details>
114+
<summary>Elyra 4.x (JupyterLab 4.2.5+)</summary>
115+
116+
- Install from PyPI
117+
118+
```bash
119+
pip3 install --upgrade "elyra[all]"
120+
```
121+
122+
- Install from conda-forge
123+
124+
```bash
125+
conda install -c conda-forge "elyra[all]"
126+
```
127+
</details>
128+
129+
<details>
130+
<summary>Elyra 3.7 < 4.0 (JupyterLab 3.x)</summary>
131+
132+
- Install from PyPI
133+
134+
```bash
135+
pip3 install --upgrade "elyra[all]<4.0.0"
136+
```
137+
138+
- Install from conda-forge
139+
140+
```bash
141+
conda install -c conda-forge "elyra[all]<4.0.0"
142+
```
143+
</details>
144+
113145
<details>
114146
<summary>Elyra 3.1 < 3.7 (JupyterLab 3.x)</summary>
115147

docs/source/developer_guide/contributing.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,13 @@ Then, in the `package.json`, add the following under `'scripts'`:
102102
```
103103
And the following under `'dev_dependencies'`:
104104
```
105-
"@jupyterlab/testutils": "3.4.0",
106-
"@types/jest": "^23.3.11",
107-
"jest": "^24.7.1",
105+
"@jupyterlab/testutils": "4.2.5",
106+
"@types/jest": "^29.2.0",
107+
"jest": "^29.2.0",
108108
"jest-raw-loader": "^1.0.1",
109-
"ts-jest": "^24.0.2",
109+
"ts-jest": "^29.2.5",
110+
"ts-loader": "^6.2.1",
111+
"typescript": "~5.1.6",
110112
```
111113
Create a file `tsconfig.test.json` that contains:
112114
```

docs/source/getting_started/installation.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--
1+
<!--
22
{% comment %}
33
Copyright 2018-2023 Elyra Authors
44
@@ -21,17 +21,18 @@ The Elyra [JupyterLab extensions](https://jupyterlab.readthedocs.io/en/stable/us
2121

2222
### Prerequisites
2323

24-
* [Node.js 18+](https://nodejs.org/en/)
25-
* [Python 3.8+](https://www.python.org/downloads/) (or later)
24+
* [Node.js 20+](https://nodejs.org/en/)
25+
* [Python 3.9+](https://www.python.org/downloads/) (or later)
2626

2727
JupyterLab dependencies:
28+
- Elyra >= 4.0.0 requires JupyterLab 4.x
2829
- Elyra >= 2.0.0 requires JupyterLab 3.x
2930

3031
The instructions below are installing the latest release.
3132

3233
### Packaging
3334

34-
Prior to version 3.1, the `elyra` package included all dependencies. Subsequent releases allow for selective dependency installation:
35+
You can install elyra with all optional dependencies or with specific dependencies:
3536

3637
- `elyra` - install the Elyra core features (except kfp dependencies)
3738
- `elyra[all]` - install core features and all dependencies
@@ -44,7 +45,7 @@ Prior to version 3.1, the `elyra` package included all dependencies. Subsequent
4445

4546
### pip
4647

47-
If you use `pip`, install Elyra with:
48+
If you use `pip`, install Elyra together with all dependencies with:
4849

4950
```bash
5051
pip3 install --upgrade "elyra[all]"
@@ -64,12 +65,6 @@ If desired, you can install these Elyra extensions independently:
6465
pip3 install --upgrade elyra-code-snippet-extension
6566
```
6667

67-
- [Code Viewer](https://pypi.org/project/elyra-code-viewer-extension/)
68-
69-
```bash
70-
pip3 install --upgrade elyra-code-viewer-extension
71-
```
72-
7368
- [Python Editor](https://pypi.org/project/elyra-python-editor-extension/)
7469

7570
```bash
@@ -109,10 +104,6 @@ conda install -c conda-forge elyra-pipeline-editor-extension
109104
conda install -c conda-forge elyra-code-snippet-extension
110105
```
111106

112-
```bash
113-
conda install -c conda-forge elyra-code-viewer-extension
114-
```
115-
116107
```bash
117108
conda install -c conda-forge elyra-python-editor-extension
118109
```
@@ -121,7 +112,9 @@ conda install -c conda-forge elyra-python-editor-extension
121112
conda install -c conda-forge elyra-r-editor-extension
122113
```
123114

124-
**NOTE:** The R Editor extension is not yet available on `conda-forge` or `pip` package manager.
115+
```bash
116+
conda install -c conda-forge elyra-scala-editor-extension
117+
```
125118

126119
### Build from source
127120

0 commit comments

Comments
 (0)