Skip to main content

Server Extension for Jupyter notebooks to connect to openBIS and download/upload datasets, inluding the notebook itself

Project description

Jupyter openBIS Server

The server part of the jupyter-openbis-extension and jupyterlab-openbis notebook extension. Uses the pyBIS module internally to communicate with openBIS. Communicates with the notebook extensions via the tornado webserver.

Install the server extension

The server extension will be automatically installed when you install the Jupyter Notebook Extension (the «classic» Jupyter Notebook):

pip install --upgrade jupyter-openbis-extension

If you need to install or upgrade the server extension alone, you can do so by:

pip install --upgrade jupyter-openbis-server

install Jupyter extension manually

In most cases, a simple pip install --upgrade jupyter-openbis-server will install the server extension. However, in some cases (e.g. when installing via pip install -e .) you need to issue the following command to register the extension:

**In the library path, e.g. etc/jupyter/

$ jupyter serverextension enable --py jupyter-openbis-server --sys-prefix

This will create a file ~/.jupyter/jupyter_notebook_config.json with the following content:

{
  "NotebookApp": {
    "nbserver_extensions": {
      "jupyter-openbis-server.main": true
    }
  }
}

Uninstall Jupyter openBIS Server

Unfortunately, pip doesn't automatically clean up the Jupyter configuration when uninstalling. You have to do it yourself:

$ jupyter serverextension disable --py jupyter-openbis-server
$ pip uninstall jupyter-openbis-server

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-openbis-server-0.1.3.tar.gz (12.6 kB view details)

Uploaded Source

File details

Details for the file jupyter-openbis-server-0.1.3.tar.gz.

File metadata

  • Download URL: jupyter-openbis-server-0.1.3.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.0

File hashes

Hashes for jupyter-openbis-server-0.1.3.tar.gz
Algorithm Hash digest
SHA256 f410a3872ae507caae650e7f9c7a5e10e02577bfdd388b820c9164b6f28f7118
MD5 cdb1ae5127856676ad9f1ac6d5426a46
BLAKE2b-256 de9bec5c0e9ccac82252bcdbc0b5ce56e2cbe49496a7b10a734f8c97a9e067c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page