https://github.com/davidbrochart/jupyter-shared-drive

A Jupyter drive for sharing files and collaborating in real time.
https://github.com/davidbrochart/jupyter-shared-drive

Last synced: 4 months ago
JSON representation

A Jupyter drive for sharing files and collaborating in real time.

• Host: GitHub
• URL: https://github.com/davidbrochart/jupyter-shared-drive
• Owner: davidbrochart
• License: other
• Created: 2024-08-23T14:07:12.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-13T14:12:32.000Z (about 1 year ago)
• Last Synced: 2025-02-01T10:01:42.933Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 504 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Jupyter Shared Drive

[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://davidbrochart.github.io/jupyter-shared-drive)

[![Build Status](https://github.com/davidbrochart/jupyter-shared-drive/actions/workflows/test.yml/badge.svg?query=branch%3Amain++)](https://github.com/davidbrochart/jupyter-shared-drive/actions?query=branch%3Amain++)

[![PyPI](https://img.shields.io/pypi/v/jupyter-shared-drive)](https://pypi.org/project/jupyter-shared-drive)

[![npm](https://img.shields.io/npm/v/@jupyter/shared-drive-extension)](https://www.npmjs.com/package/@jupyter/shared-drive-extension)

Jupyter Shared Drive consists of an optional Jupyter Server extension and a JupyterLab extension providing support for [Y documents](https://github.com/jupyter-server/jupyter_ydoc) and adding a new drive for sharing these documents through WebRTC.

The server extension provides the signaling service needed for peers to discover each other. It will typically be installed and used with a full JupyterLab setup, but it is not mandatory. For instance, a public signaling server can be used instead, and the JupyterLab frontend extension can be configured to use it. This means that Jupyter Shared Drive can be used without a Jupyter server, and that it works in JupyterLite 🚀

## Installation and Basic usage

To install the latest release locally, make sure you have

[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:

```bash

pip install jupyter-shared-drive

```

Or using ``conda``/``mamba``/``micromamba`` (soon!):

```bash

conda install -c conda-forge jupyter-shared-drive

```

In JupyterLab, a new drive is made available with prefix `Shared:`, and accessible through a `Shared Drive` file browser at the bottom of the left toolbar. It is separate from the default drive (accessible through the file browser at the top), but files can be imported/exported from/to it. Files in the shared drive are stored in each client's browser, and synchronized with connected clients.