Realtime collaboration for JupyterLab using Google Drive
TypeScript CSS JavaScript Shell
Latest commit b6b0c37 Nov 11, 2017 @ian-r-rose ian-r-rose Merge pull request #97 from ian-r-rose/resolve_nosessionbound
Resolve nosessionbound

README.md

jupyterlab-google-drive

Build Status

Realtime collaboration and cloud storage for JupyterLab through Google Drive.

NOTE: this is alpha software and is rapidly changing. Files stored on Google Drive using this plugin should still be backed-up elsewhere.

This extension adds a Google Drive filebrowser to the left sidepanel of JupyterLab. When you are logged into your Google account, you will have the files stored in it available to JupyterLab. Notebooks and text files may be shared and edited with collaborators in real-time, and all users will see the same changes.

To see the extension in action, click on our live demo from PyData Seattle:

PyData Seattle Talk

For the time-being, all users running a notebook have independent kernels for code execution, and the outputs from running cells will reflect that.

Google's servers expect traffic from computers using http://localhost on ports8888 through 8899, and other origins will be rejected, so drive integration will not work. See advanced.md for instructions on how to set up your own credentials with Google's servers.

If you run into troubles, see if the troubleshooting guide has a solution for you.

Prerequisites

  • JupyterLab 0.29
  • A Google Drive account

Installation

To install this extension into JupyterLab (requires node 5 or later), do the following:

jupyter labextension install @jupyterlab/google-drive

Development

For a development install, do the following in the repository directory:

npm install
npm run build
jupyter labextension link .

To rebuild the package and the JupyterLab app after making changes:

npm run build
jupyter lab build

Getting Started from Scratch

  • Install JupyterLab

    pip install jupyterlab
    
  • Install the jupyterlab-google-drive extension

    jupyter labextension install @jupyterlab/google-drive
    
  • Start JupyterLab

    jupyter lab
    
  • Click on Google Drive tab (on left side) in JupyterLab interface and login to your Google Drive account.

  • Have someone share a notebook or markdown file with you.

  • You should now see the file in the Shared with Me folder in the file browser. Open it, and begin editing!