Name: jupyterlab-google-drive
Owner: JupyterLab
Description: Realtime collaboration for JupyterLab using Google Drive
Created: 2016-12-17 01:40:45.0
Updated: 2018-01-17 17:43:39.0
Pushed: 2018-01-10 17:37:40.0
Homepage: null
Size: 1388
Language: TypeScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
As of November 28th, 2017, Google has deprecated their Realtime API. Existing realtime applications (such as those you may have set up according to these instructions) will still work until December 2018, but new applications will not be able to use the Realtime API. See the discussions here and here for more information.
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:
For the time-being, all users running a notebook have independent kernels for code execution, and the outputs from running cells will reflect that.
The application sends a “client ID” to Google's servers to identify itself.
The default client ID used by the app is set up to work on computers
running JupyterLab using http://localhost
on ports 8888
through 8899
.
Other origins will be rejected, so drive integration will not work.
Since this extension with the default client ID can be run by anyone, it is considered “unverified”, and potentially unsafe, and Google will present a warning message to you. If you plan to use the extension extensively, you may want to set up your own client ID. See advanced.md for instructions on how to set up credentials with Google's servers.
If you run into troubles, see if the troubleshooting guide has a solution for you.
To install this extension into JupyterLab (requires node 5 or later), do the following:
ter labextension install @jupyterlab/google-drive
For a development install, do the following in the repository directory:
install
run build
ter labextension link .
You can then run JupyterLab in developer mode to automatically pick up changes to @jupyterlab/google-drive
.
Open a terminal in the @jupyterlab/google-drive
repository directory and enter
run watch
Then launch JupyterLab using
ter lab --dev-mode
This will automatically recompile @jupyterlab/google-drive
upon changes,
and JupyterLab will rebuild itself. You should then be able to refresh the
page and see your changes.
Install JupyterLab
install jupyterlab
Install the jupyterlab-google-drive extension
ter labextension install @jupyterlab/google-drive
Start JupyterLab
ter 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!