Metadata-Version: 2.1
Name: jupyter_rtc
Version: 0.0.2
Summary: A JupyterLab extension.
Project-URL: Homepage, https://github.com/datalayer/datalayer
Project-URL: Bug Tracker, https://github.com/datalayer/datalayer/issues
Project-URL: Repository, https://github.com/datalayer/datalayer.git
Author-email: Datalayer <eric@datalayer.io>
License: BSD 3-Clause License
        
        Copyright (c) 2022, Datalayer
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 3
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7
Requires-Dist: jupyter-server<3,>=1.6
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-tornasync; extra == 'test'
Description-Content-Type: text/markdown

[![Datalayer](https://assets.datalayer.design/datalayer-25.svg)](https://datalayer.io)

# Jupyter RTC

> 🪐 👥 Multi-user Jupyter server with realtime history backed by Apache Cassandra

The Realtime collaboration for Jupyter is being actively designed and developed by the Jupyter community. The RTC feature presents technical challenges for security (how to secure and trust a notebook being edited by multiple users). The current jupyter server is also not multi-user which can for some use cases be limiting. RTC nature goes also beyond what the current community is used to (a lot of historical data needs to be persisted which demands central and scalable infrastructure, so not really the casual laptop with a notebook). We are also facing divergence in the community in how the JupyterLab components will be further developed. The vote to remove the JupyterLab shared-model package has just passed https://github.com/jupyterlab/jupyterlab/issues/12708#issuecomment-1179837791 and the decision goes against the reusability for third party applications. Datalayer is willing to offer a one-stop solution with an end-user model a-la-nbformat which will be collaborative (nbshared), backed by a multi-user Jupyter server with realtime history capabilities. The user history will be persisted in a local file, in PostgreSQL or in Apache Cassandra.

The repository will be hosted under https://github.com/datalayer/jupyter-rtc. The planned deliverables are a “nbshared” model the first 3 months, a multi-user server with history on local file the first 6 months, PostgreSQL and Cassandra support after 1 year.

```bash
pip install -e .[test]
jupyter labextension develop . --overwrite
jupyter labextension list
jupyter server extension list
# open http://localhost:8686/api/jupyter/lab?token=60c1661cc408f978c309d04157af55c9588ff9557c9380e4fb50785750703da6
yarn jupyterlab
```
