Skip to content

Commit d7170f1

Browse files
authored
Merge pull request #84 from ITC-CRIB/jupyterlab3
Changes for release 0.3.1
2 parents 75e80ef + 996be29 commit d7170f1

File tree

7 files changed

+261
-214
lines changed

7 files changed

+261
-214
lines changed

jupyter_fairly/README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ for the frontend extension.
99

1010
## Requirements
1111

12-
- JupyterLab >= 3.0
13-
- fairly
12+
- JupyterLab >= 3.0 < 4
13+
- fairly >= 0.4.0
14+
15+
> This is the last version supported by JupyterLab 3.x.
1416
1517
## Install
1618

@@ -20,7 +22,12 @@ To install the extension, execute:
2022
pip install jupyter_fairly
2123
```
2224

23-
To run the extension, start JupyterLab. If JupyterLab was running during installation, a *restart is required.*
25+
Configurations are stored in `.fairly/config.json` in the user's home directory. This is where the extension stores access tokens for data repositories.
26+
27+
To add an access tokens, use the **Fairly** menu in the JupyterLab main menu bar.
28+
29+
<img src="../img/fairly_menu.png" alt="Fairly Menu" width="450"/>
30+
2431

2532
## Uninstall
2633

@@ -48,9 +55,9 @@ jupyter labextension list
4855

4956
## Contributing
5057

51-
### Development installation
58+
### Development install
5259

53-
> Note: You will need NodeJS to build the extension package.
60+
Note: You will need NodeJS to build the extension package.
5461

5562
The `jlpm` command is JupyterLab's pinned version of
5663
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
@@ -66,7 +73,7 @@ jupyter labextension develop . --overwrite
6673
# Server extension must be manually installed in develop mode
6774
jupyter server extension enable jupyter_fairly
6875
# Rebuild extension Typescript source after making changes
69-
jlpm run build
76+
jlpm build
7077
```
7178

7279
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
@@ -157,4 +164,3 @@ Project members:
157164
- [Center of Expertise in Big Geodata Science, University of Twente, Faculty ITC](https://itc.nl/big-geodata/)
158165
- [Digital Competence Centre, TU Delft](https://dcc.tudelft.nl/)
159166
- [4TU.ResearchData](https://data.4tu.nl/)
160-

0 commit comments

Comments
 (0)