jupyter-server-ydoc-codio 2.1.1__tar.gz

jupyter_server_ydoc_codio-2.1.1/.gitignore

@@ -0,0 +1,135 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+package-lock.json
+docs/source/ts
+.jupyter
+labextension
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+docs/source/changelog.md
+
+.pnp.*
+.yarn/
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+packages/docprovider/junit.xml
+packages/docprovider-codio/junit.xml
+.jupyter_ystore.db

jupyter_server_ydoc_codio-2.1.1/LICENSE

@@ -0,0 +1,59 @@
+# Licensing terms
+
+This project is licensed under the terms of the Modified BSD License
+(also known as New or Revised or 3-Clause BSD), as follows:
+
+- Copyright (c) 2021-, Jupyter Development Team
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+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.
+
+Neither the name of the Jupyter Development Team 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 OWNER 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.
+
+## About the Jupyter Development Team
+
+The Jupyter Development Team is the set of all contributors to the Jupyter project.
+This includes all of the Jupyter subprojects.
+
+The core team that coordinates development on GitHub can be found here:
+https://github.com/jupyter/.
+
+## Our Copyright Policy
+
+Jupyter uses a shared copyright model. Each contributor maintains copyright
+over their contributions to Jupyter. But, it is important to note that these
+contributions are typically only changes to the repositories. Thus, the Jupyter
+source code, in its entirety is not the copyright of any single person or
+institution. Instead, it is the collective copyright of the entire Jupyter
+Development Team. If individual contributors want to maintain a record of what
+changes/contributions they have specific copyright on, they should indicate
+their copyright in the commit message of the change, when they commit the
+change to one of the Jupyter repositories.
+
+With this in mind, the following banner should be used in any source code file
+to indicate the copyright and license terms:
+
+    # Copyright (c) Jupyter Development Team.
+    # Distributed under the terms of the Modified BSD License.

jupyter_server_ydoc_codio-2.1.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: jupyter-server-ydoc-codio
+Version: 2.1.1
+Summary: fork of jupyter-server extension integrating collaborative shared models.
+Project-URL: Documentation, https://jupyterlab-realtime-collaboration.readthedocs.io/
+Project-URL: Repository, https://github.com/codio/jupyter-collaboration
+Project-URL: Changelog, https://jupyterlab-realtime-collaboration.readthedocs.io/en/latest/changelog.html
+Project-URL: Source, https://github.com/codio/jupyter-collaboration/tree/main/projects/jupyter-server-ydoc-codio
+Project-URL: Issues, https://github.com/codio/jupyter-collaboration/issues/new/choose
+Author-email: Jupyter Development Team <jupyter@googlegroups.com>
+License: # Licensing terms
+        
+        This project is licensed under the terms of the Modified BSD License
+        (also known as New or Revised or 3-Clause BSD), as follows:
+        
+        - Copyright (c) 2021-, Jupyter Development Team
+        
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        Redistributions of source code must retain the above copyright notice, this
+        list of conditions and the following disclaimer.
+        
+        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.
+        
+        Neither the name of the Jupyter Development Team 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 OWNER 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.
+        
+        ## About the Jupyter Development Team
+        
+        The Jupyter Development Team is the set of all contributors to the Jupyter project.
+        This includes all of the Jupyter subprojects.
+        
+        The core team that coordinates development on GitHub can be found here:
+        https://github.com/jupyter/.
+        
+        ## Our Copyright Policy
+        
+        Jupyter uses a shared copyright model. Each contributor maintains copyright
+        over their contributions to Jupyter. But, it is important to note that these
+        contributions are typically only changes to the repositories. Thus, the Jupyter
+        source code, in its entirety is not the copyright of any single person or
+        institution. Instead, it is the collective copyright of the entire Jupyter
+        Development Team. If individual contributors want to maintain a record of what
+        changes/contributions they have specific copyright on, they should indicate
+        their copyright in the commit message of the change, when they commit the
+        change to one of the Jupyter repositories.
+        
+        With this in mind, the following banner should be used in any source code file
+        to indicate the copyright and license terms:
+        
+            # Copyright (c) Jupyter Development Team.
+            # Distributed under the terms of the Modified BSD License.
+License-File: LICENSE
+Classifier: Framework :: Jupyter
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: jsonschema>=4.18.0
+Requires-Dist: jupyter-events>=0.11.0
+Requires-Dist: jupyter-server-fileid<1,>=0.7.0
+Requires-Dist: jupyter-server<3.0.0,>=2.15.0
+Requires-Dist: jupyter-ydoc<4.0.0,>=3.0.3
+Requires-Dist: pycrdt
+Requires-Dist: pycrdt-websocket<0.17.0,>=0.16.0
+Provides-Extra: test
+Requires-Dist: anyio; extra == 'test'
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: dirty-equals; extra == 'test'
+Requires-Dist: httpx-ws>=0.5.2; extra == 'test'
+Requires-Dist: importlib-metadata>=4.8.3; (python_version < '3.10') and extra == 'test'
+Requires-Dist: jupyter-server-fileid[test]; extra == 'test'
+Requires-Dist: jupyter-server[test]>=2.15.0; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# codio fork of jupyter-server-ydoc
+
+jupyter-server extension integrating collaborative shared models.
+
+The collaborative shared models are used for both:
+- real time collaboration, and
+- server-side execution of notebooks

jupyter_server_ydoc_codio-2.1.1/README.md

@@ -0,0 +1,7 @@
+# codio fork of jupyter-server-ydoc
+
+jupyter-server extension integrating collaborative shared models.
+
+The collaborative shared models are used for both:
+- real time collaboration, and
+- server-side execution of notebooks

jupyter_server_ydoc_codio-2.1.1/jupyter-config/jupyter_server_ydoc_codio.json

@@ -0,0 +1,7 @@
+{
+  "ServerApp": {
+    "jpserver_extensions": {
+      "jupyter_server_ydoc_codio": true
+    }
+  }
+}

jupyter_server_ydoc_codio-2.1.1/jupyter_server_ydoc_codio/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+from typing import Any, Dict, List
+
+from ._version import __version__  # noqa
+from .app import YDocExtension
+
+
+def _jupyter_server_extension_points() -> List[Dict[str, Any]]:
+    return [{"module": "jupyter_server_ydoc_codio", "app": YDocExtension}]

jupyter_server_ydoc_codio-2.1.1/jupyter_server_ydoc_codio/_version.py

@@ -0,0 +1 @@
+__version__ = "2.1.1"

jupyter_server_ydoc_codio-2.1.1/jupyter_server_ydoc_codio/app.py

@@ -0,0 +1,225 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+from __future__ import annotations
+
+import asyncio
+from functools import partial
+from typing import Literal
+
+from jupyter_server.extension.application import ExtensionApp
+from jupyter_ydoc import ydocs as YDOCS
+from jupyter_ydoc.ybasedoc import YBaseDoc
+from pycrdt import Doc
+from pycrdt.store import BaseYStore
+from traitlets import Bool, Float, Type
+
+from .handlers import (
+    DocForkHandler,
+    DocSessionHandler,
+    TimelineHandler,
+    UndoRedoHandler,
+    YDocWebSocketHandler,
+)
+from .loaders import FileLoaderMapping
+from .rooms import DocumentRoom
+from .custom_stores import CustomSQLiteYStore
+from .utils import (
+    AWARENESS_EVENTS_SCHEMA_PATH,
+    EVENTS_SCHEMA_PATH,
+    FORK_EVENTS_SCHEMA_PATH,
+    encode_file_path,
+    room_id_from_encoded_path,
+)
+from .websocketserver import JupyterWebsocketServer, RoomNotFound, exception_logger
+
+
+class YDocExtension(ExtensionApp):
+    name = "jupyter_server_ydoc_codio"
+    app_name = "Collaboration"
+    description = """
+    Enables Real Time Collaboration in JupyterLab
+    """
+
+    disable_rtc = Bool(False, config=True, help="Whether to disable real time collaboration.")
+
+    file_poll_interval = Float(
+        1,
+        config=True,
+        help="""The period in seconds to check for file changes on disk.
+        Defaults to 1s, if 0 then file changes will only be checked when
+        saving changes from the front-end.""",
+    )
+
+    document_cleanup_delay = Float(
+        60,
+        allow_none=True,
+        config=True,
+        help="""The delay in seconds to keep a document in memory in the back-end after all clients
+        disconnect. Defaults to 60s, if None then the document will be kept in memory forever.""",
+    )
+
+    document_save_delay = Float(
+        1,
+        allow_none=True,
+        config=True,
+        help="""The delay in seconds to wait after a change is made to a document before saving it.
+        Defaults to 1s, if None then the document will never be saved.""",
+    )
+
+    ystore_class = Type(
+        default_value=CustomSQLiteYStore,
+        klass=BaseYStore,
+        config=True,
+        help="""The YStore class to use for storing Y updates. Defaults to an SQLiteYStore,
+        which stores Y updates in a '.jupyter_ystore.db' SQLite database in the current
+        directory.""",
+    )
+
+    server_side_execution = Bool(
+        False,
+        config=True,
+        help="""Whether to execute notebooks in the server using the REST API, not using the kernel
+        protocol over WebSocket. The frontend only interacts with the notebook through its shared
+        model.""",
+    )
+
+    def initialize(self):
+        super().initialize()
+        self.serverapp.event_logger.register_event_schema(EVENTS_SCHEMA_PATH)
+        self.serverapp.event_logger.register_event_schema(AWARENESS_EVENTS_SCHEMA_PATH)
+        self.serverapp.event_logger.register_event_schema(FORK_EVENTS_SCHEMA_PATH)
+
+    def initialize_settings(self):
+        self.settings.update(
+            {
+                "collaborative_file_poll_interval": self.file_poll_interval,
+                "collaborative_document_cleanup_delay": self.document_cleanup_delay,
+                "collaborative_document_save_delay": self.document_save_delay,
+                "collaborative_ystore_class": self.ystore_class,
+            }
+        )
+
+    def initialize_handlers(self):
+        page_config = self.serverapp.web_app.settings.setdefault("page_config_data", {})
+        page_config.setdefault("disableRTC", self.disable_rtc)
+        page_config.setdefault("serverSideExecution", self.server_side_execution)
+
+        # Set configurable parameters to YStore class
+        ystore_class: type[BaseYStore] = partial(self.ystore_class, config=self.config)  # type:ignore[assignment]
+
+        self.ywebsocket_server = JupyterWebsocketServer(
+            rooms_ready=False,
+            auto_clean_rooms=False,
+            ystore_class=ystore_class,
+            # Log exceptions, because we don't want the websocket server
+            # to _ever_ crash permanently in a live jupyter_server.
+            exception_handler=exception_logger,
+            log=self.log,
+        )
+
+        # self.settings is local to the ExtensionApp but here we need
+        # the global app settings in which the file id manager will register
+        # itself maybe at a later time.
+        self.file_loaders = FileLoaderMapping(
+            self.serverapp.web_app.settings, self.log, self.file_poll_interval
+        )
+
+        self.handlers.extend(
+            [
+                (
+                    r"/api/collaboration/fork/(.*)",
+                    DocForkHandler,
+                    {
+                        "ywebsocket_server": self.ywebsocket_server,
+                    },
+                ),
+                (
+                    r"/api/collaboration/room/(.*)",
+                    YDocWebSocketHandler,
+                    {
+                        "document_cleanup_delay": self.document_cleanup_delay,
+                        "document_save_delay": self.document_save_delay,
+                        "file_loaders": self.file_loaders,
+                        "ystore_class": ystore_class,
+                        "ywebsocket_server": self.ywebsocket_server,
+                    },
+                ),
+                (r"/api/collaboration/session/(.*)", DocSessionHandler),
+                (
+                    r"/api/collaboration/timeline/(.*)",
+                    TimelineHandler,
+                    {
+                        "ystore_class": self.ystore_class,
+                        "ywebsocket_server": self.ywebsocket_server,
+                    },
+                ),
+                (
+                    r"/api/collaboration/undo_redo/(.*)",
+                    UndoRedoHandler,
+                    {
+                        "ywebsocket_server": self.ywebsocket_server,
+                    },
+                ),
+            ]
+        )
+
+    async def get_document(
+        self: YDocExtension,
+        *,
+        path: str | None = None,
+        content_type: str | None = None,
+        file_format: Literal["json", "text"] | None = None,
+        room_id: str | None = None,
+        copy: bool = True,
+    ) -> YBaseDoc | None:
+        """Get a view of the shared model for the matching document.
+
+        You need to provide either a ``room_id`` or the ``path``,
+        the ``content_type`` and the ``file_format``.
+
+        If `copy=True`, the returned shared model is a fork, meaning that any changes
+         made to it will not be propagated to the shared model used by the application.
+        """
+        error_msg = "You need to provide either a ``room_id`` or the ``path``, the ``content_type`` and the ``file_format``."
+        if room_id is None:
+            if path is None or content_type is None or file_format is None:
+                raise ValueError(error_msg)
+
+            file_id_manager = self.serverapp.web_app.settings["file_id_manager"]
+            file_id = file_id_manager.index(path)
+
+            encoded_path = encode_file_path(file_format, content_type, file_id)
+            room_id = room_id_from_encoded_path(encoded_path)
+
+        elif path is not None or content_type is not None or file_format is not None:
+            raise ValueError(error_msg)
+        else:
+            room_id = room_id
+
+        try:
+            room = await self.ywebsocket_server.get_room(room_id)
+        except RoomNotFound:
+            return None
+
+        if isinstance(room, DocumentRoom):
+            if copy:
+                update = room.ydoc.get_update()
+
+                fork_ydoc: Doc = Doc()
+                fork_ydoc.apply_update(update)
+
+                return YDOCS.get(room.file_type, YDOCS["file"])(fork_ydoc)
+            else:
+                return room._document
+
+        return None
+
+    async def stop_extension(self):
+        # Cancel tasks and clean up
+        await asyncio.wait(
+            [
+                asyncio.create_task(self.ywebsocket_server.clean()),
+                asyncio.create_task(self.file_loaders.clear()),
+            ],
+            timeout=3,
+        )

jupyter_server_ydoc_codio-2.1.1/jupyter_server_ydoc_codio/custom_stores.py

@@ -0,0 +1,20 @@
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+
+from pathlib import Path
+from traitlets import Unicode
+from .stores import SQLiteYStore
+
+class CustomSQLiteYStore(SQLiteYStore):
+    db_dir = ".guides"
+
+    db_path = Unicode(
+        ".guides/.jupyter_ystore.db",
+        config=True,
+        help="""The path to the YStore database. Defaults to '.guides/.jupyter_ystore.db' in the current
+        directory.""",
+    )
+
+    def __init__(self, **kwargs):
+        Path(self.db_dir).mkdir(parents=True, exist_ok=True)
+        super().__init__(**kwargs)

jupyter_server_ydoc_codio-2.1.1/jupyter_server_ydoc_codio/events/awareness.yaml

@@ -0,0 +1,33 @@
+"$id": https://schema.jupyter.org/jupyter_collaboration/awareness/v1
+"$schema": "http://json-schema.org/draft-07/schema"
+version: "1"
+title: Collaborative awareness events
+personal-data: true
+description: |
+  Awareness events emitted from server-side during a collaborative session.
+type: object
+required:
+  - roomid
+  - username
+  - action
+properties:
+  roomid:
+    type: string
+    description: |
+      Room ID. Usually composed by the file type, format and ID.
+  username:
+    type: string
+    description: |
+      The name of the user who joined or left room.
+  action:
+    enum:
+      - join
+      - leave
+    description: |
+      Possible values:
+      1. join
+      2. leave
+  msg:
+    type: string
+    description: |
+      Optional event message.

jupyter_server_ydoc_codio-2.1.1/jupyter_server_ydoc_codio/events/fork.yaml

@@ -0,0 +1,56 @@
+"$id": https://schema.jupyter.org/jupyter_collaboration/fork/v1
+"$schema": "http://json-schema.org/draft-07/schema"
+version: "1"
+title: Collaborative fork events
+personal-data: true
+description: |
+  Fork events emitted from server-side during a collaborative session.
+type: object
+required:
+  - fork_roomid
+  - fork_info
+  - username
+  - action
+properties:
+  fork_roomid:
+    type: string
+    description: |
+      Fork root room ID.
+  fork_info:
+    type: object
+    description: |
+      Fork root room information.
+    required:
+      - root_roomid
+      - synchronize
+      - title
+      - description
+    properties:
+      root_roomid:
+        type: string
+        description: |
+          Root room ID. Usually composed by the file type, format and ID.
+      synchronize:
+        type: boolean
+        description: |
+          Whether the fork is kept in sync with the root.
+      title:
+        type: string
+        description: |
+          The title of the fork.
+      description:
+        type: string
+        description: |
+          The description of the fork.
+  username:
+    type: string
+    description: |
+      The name of the user who created or deleted the fork.
+  action:
+    enum:
+      - create
+      - delete
+    description: |
+      Possible values:
+      1. create
+      2. delete