cs3api4lab

This is an Extension for Jupyterlab that allow the retrieval of files and added functionality (i.e sharing) provided by the CS3APIs.

This extension is composed of a Python package named cs3api4lab for the server extension and a NPM package named cs3api4lab for the frontend extension.

The Python package implements the Jupyter ContentsManager and Checkpoints interfaces, and can be used to replace the default managers.

Requirements

JupyterLab >= 3.0

Contributing

Development install

Note: You will need NodeJS (ver 14.x) to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the cs3api4lab directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable cs3api4lab
# Rebuild extension Typescript source after making changes
jlpm run build

Note: After building the project please see sections:

Disable default file browser - cs3api4lab plugin replaces default filebrowser

Setup env - before running the plugin you need to change JupyterLab configuration

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.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

# Server extension must be manually disabled in develop mode
jupyter server extension disable cs3api4lab
pip uninstall cs3api4lab

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named cs3api4lab within that folder.

Setup env for integration testing

Create local IOP instance

Follow the first 3 steps from this tutorial https://reva.link/docs/tutorials/share-tutorial/ or create with commands:

git clone https://github.com/cs3org/reva
cd reva
make deps
make
mkdir -p /var/tmp/reva
cd examples/ocmd/
../../cmd/revad/revad -c ocmd-server-1.toml

Run test

Goto test folder:

cd cs3api4lab/tests

Run cs3 API connector test:

python test_cs3_file_api.py
python test_cs3apismanager.py

Setup env

Create config:

jupyter server --generate-config

Enable CS3 File Content Manager Replace in file HOME_FOLDER/.jupyter/jupyter_server_config.py line

c.ServerApp.contents_manager_class = 'notebook.services.contents.largefilemanager.LargeFileManager'

c.ServerApp.contents_manager_class = 'cs3api4lab.CS3APIsManager'

Disable default file browser

To disable the default file browser use these commands in the console:

jupyter labextension disable @jupyterlab/filebrowser-extension:browser

You can also use a config file to disable the default file browser, copy page_config.json from jupyter-config/page_config.json to:

Windows: C:\Users\{USER_PROFILE}\.jupyter\labconfig
Linux: HOME_FOLDER/.jupyter/labconfig

CS3 config file

Copy cs3 example config file from "jupyter-config/jupyter_cs3_config.json" to:

Windows: C:\Users\{USER_PROFILE}\.jupyter\
Linux: HOME_FOLDER/.jupyter/

Check out the available config variables see config_manager.py for reference.

Examples of different authentication methods:

If you want to use a different authentication method replace the "authenticator_class" in the config file and put necessary config values for authenticator class.

Reva user and secret:

{
 "cs3":{
   ...
   "authenticator_class": "cs3api4lab.auth.RevaPassword",
   "client_id": "einstein",
   "client_secret": "relativity"
   }
}

Oauth token from config value

{
 "cs3":{
   ...
   "authenticator_class": "cs3api4lab.auth.Oauth",
   "oauth_token":"OUATH TOKEN",
   "client_id": "einstein"
   }
}

Oauth token from file

{
 "cs3":{
   ...
   "authenticator_class": "cs3api4lab.auth.Oauth",
   "oauth_token":"PATH TO FILE",
   "client_id": "einstein"
   }
}

Eos token from config value

{
 "cs3":{
   ...
   "authenticator_class": "cs3api4lab.auth.Eos",
   "eos_token":"oauth2:<OAUTH_TOKEN>:<OAUTH_INSPECTION_ENDPOINT>",
   "client_id": "einstein"
   }
}

Eos token from file

{
 "cs3":{
   ...
   "authenticator_class": "cs3api4lab.auth.Eos",
   "eos_file":"PATH TO FILE",
   "client_id": "einstein"
   }
}

Install

Note: This version of installation method is not ready yet. Please use Development installation instructions.

To install the extension, execute:

pip install cs3api4lab

Uninstall

To remove the extension, execute:

pip uninstall cs3api4lab

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Setup for docker image

Build docker image from local source code

Clone the repo:

git clone https://github.com/sciencemesh/cs3api4lab.git
cd cs3api4lab

Build docker image:

docker build -t cs3api4lab .

To run docker image providing necessary config environmental variables to the container use the names with capital spelling and CS3_ prefix, i.e:

docker run -p 8888:8888 -e CS3_CLIENT_ID=einstein -e CS3_CLIENT_SECRET=relativity -e CS3_REVA_HOST=localhost:19000 cs3api4lab

Run docker image after overwriting the config variables explicitly or in the reva_config.env:

docker run -p 8888:8888 --env-file reva_config.env cs3api4lab

sciencemesh / cs3api4lab