Renames python package and lab extension

.eslintignore

@@ -12,7 +12,7 @@ docs
 tests
 .eslintrc.js
 jupyter-config
-jupyterlab_rtc
+jupyterlab_collaboration
 
 packages/collaboration/babel.config.js
 packages/docprovider/babel.config.js

.github/workflows/test.yml

@@ -68,7 +68,7 @@ jobs:
       - name: Run the tests with Coverage
         if: ${{ !startsWith(matrix.python-version, 'pypy') && !startsWith(runner.os, 'Windows') }}
         run: |
-          python -m pytest -vv --cov jupyterlab_rtc --cov-branch --cov-report term-missing:skip-covered
+          python -m pytest -vv --cov jupyterlab_collaboration --cov-branch --cov-report term-missing:skip-covered
       - name: Run the tests on pypy and Windows
         if: ${{ startsWith(matrix.python-version, 'pypy') || startsWith(runner.os, 'Windows') }}
         run: |
@@ -132,7 +132,7 @@ jobs:
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       - uses: jupyterlab/maintainer-tools/.github/actions/test-sdist@v1
         with:
-          extra_test: 'jupyter server extension list 2>&1 | grep -ie "jupyterlab_rtc.*OK"'
+          extra_test: 'jupyter server extension list 2>&1 | grep -ie "jupyterlab_collaboration.*OK"'
 
   check_links:
     runs-on: ubuntu-latest

.gitignore

@@ -9,10 +9,10 @@ node_modules/
 *.tsbuildinfo
 package-lock.json
 docs/source/ts
-jupyterlab_rtc/labextension
+jupyterlab_collaboration/labextension
 
 # Version file is handled by hatchling
-jupyterlab_rtc/_version.py
+jupyterlab_collaboration/_version.py
 
 # Integration tests
 ui-tests/test-results/

.prettierignore

@@ -11,5 +11,5 @@
 docs
 tests
 jupyter-config
-jupyterlab_rtc
+jupyterlab_collaboration
 .mypy_cache

README.md

@@ -1,6 +1,6 @@
 # JupyterLab Real-Time Collaboration
 
-[![Build Status](https://github.com/jupyterlab/jupyterlab_rtc/actions/workflows/test.yml/badge.svg?query=branch%3Amain++)](https://github.com/jupyterlab/jupyterlab_rtc/actions?query=branch%3Amain++)
+[![Build Status](https://github.com/jupyterlab/jupyterlab_collaboration/actions/workflows/test.yml/badge.svg?query=branch%3Amain++)](https://github.com/jupyterlab/jupyterlab_collaboration/actions?query=branch%3Amain++)
 
 JupyterLab Real-Time Collaboration is a Jupyter Server Extension and JupyterLab extensions providing support for Y documents
 and adding collaboration UI elements in JupyterLab.
@@ -13,13 +13,13 @@ To install the latest release locally, make sure you have
 [pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
 
 ```bash
-pip install jupyterlab-rtc
+pip install jupyterlab_collaboration
 ```
 
 Or using ``conda``/``mamba``:
 
 ```bash
-conda install jupyterlab-rtc
+conda install jupyterlab_collaboration
 ```
 
 ### Testing

docs/source/conf.py

@@ -16,7 +16,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "jupyterlab_rtc"
+project = "jupyterlab_collaboration"
 copyright = f"2022-{time.localtime().tm_year}, Jupyter Development Team"  # noqa
 author = "Jupyter Development Team"
 release = "0.3.0"
@@ -58,7 +58,7 @@
             "type": "local",
         }
     ],
-    "github_url": "https://github.com/jupyterlab/jupyterlab_rtc",
+    "github_url": "https://github.com/jupyterlab/jupyterlab_collaboration",
     "use_edit_page_button": True,
     "show_toc_level": 1,
     "navbar_align": "left",
@@ -69,7 +69,7 @@
 # Output for github to be used in links
 html_context = {
     "github_user": "jupyterlab",  # Username
-    "github_repo": "jupyterlab_rtc",  # Repo name
+    "github_repo": "jupyterlab_collaboration",  # Repo name
     "github_version": "main",  # Version
     "conf_py_path": "/docs/source/",  # Path in the checkout to the docs root
 }
@@ -87,7 +87,7 @@ def setup(app):
     js_docs = HERE / "ts" / "api"
     collaboration = js_docs / "collaboration"
     docprovider = js_docs / "docprovider"
-    extension = js_docs / "rtc-extension"
+    extension = js_docs / "collaboration-extension"
 
     if collaboration.exists() and docprovider.exists() and extension.exists():
         # avoid rebuilding docs because it takes forever

docs/source/developer/architecture.md

@@ -9,5 +9,5 @@ COMING...
 Prior to the current implementation based on [Yjs](https://docs.yjs.dev/), other attempts using
 different technologies where tried:
 
-- Attempt based on [Automerge](https://automerge.org/). The code has been archived in that [branch](https://github.com/jupyterlab/jupyterlab_rtc/tree/automerge). You can
+- Attempt based on [Automerge](https://automerge.org/). The code has been archived in that [branch](https://github.com/jupyterlab/jupyterlab_collaboration/tree/automerge). You can
   access the [documentation there](https://jupyterlab-realtime-collaboration.readthedocs.io/en/automerge/).

docs/source/developer/contributing.rst

@@ -32,8 +32,8 @@ Once you have installed the dependencies mentioned above, use the following
 steps::
 
     pip install --upgrade pip
-    git clone https://github.com/jupyterlab/jupyterlab_rtc
-    cd jupyterlab_rtc
+    git clone https://github.com/jupyterlab/jupyterlab_collaboration
+    cd jupyterlab_collaboration
     pip install -e .
 
 If you are using a system-wide Python installation and you only want to install the server for you,
@@ -48,7 +48,7 @@ from any directory in your system with::
 Code Styling
 ^^^^^^^^^^^^
 
-``jupyterlab_rtc`` has adopted automatic code formatting so you shouldn't
+``jupyterlab_collaboration`` has adopted automatic code formatting so you shouldn't
 need to worry too much about your code style.
 As long as your code is valid,
 the pre-commit hook should take care of how it should look.
@@ -81,9 +81,9 @@ Troubleshooting the Installation
 If you do not see that your Jupyter Server is not running on dev mode, it's possible that you are
 running other instances of Jupyter Server. You can try the following steps:
 
-1. Uninstall all instances of the jupyterlab_rtc package. These include any installations you made using
+1. Uninstall all instances of the jupyterlab_collaboration package. These include any installations you made using
    pip or conda
-2. Run ``python3 -m pip install -e .`` in the jupyterlab_rtc repository to install jupyterlab_rtc from there
+2. Run ``python3 -m pip install -e .`` in the jupyterlab_collaboration repository to install jupyterlab_collaboration from there
 3. Launch with ``python3 -m jupyter_server --port 8989``, and check that the browser is pointing to ``localhost:8989``
    (rather than the default 8888). You don't necessarily have to launch with port 8989, as long as you use
    a port that is neither the default nor in use, then it should be fine.
@@ -99,7 +99,7 @@ Install dependencies::
 
 To run the Python tests, use::
 
-    pytest jupyterlab_rtc
+    pytest jupyterlab_collaboration
 
 
 Building the Docs
@@ -108,11 +108,11 @@ Building the Docs
 To build the documentation you'll need `Sphinx <http://www.sphinx-doc.org/en/master/>`_,
 `pandoc <https://pandoc.org/>`_ and a few other packages.
 
-To install (and activate) a `conda environment`_ named ``jupyterlab_rtc_docs``
+To install (and activate) a `conda environment`_ named ``jupyterlab_collaboration_docs``
 containing all the necessary packages (except pandoc), use::
 
     conda env create -f docs/environment.yml
-    conda activate jupyterlab_rtc_docs
+    conda activate jupyterlab_collaboration_docs
 
 .. _conda environment:
     https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file

docs/source/developer/python_api.rst

@@ -4,10 +4,10 @@
 Python API
 ==========
 
-.. automodule:: jupyterlab_rtc.app
+.. automodule:: jupyterlab_collaboration.app
   :members:
   :inherited-members:
 
-.. automodule:: jupyterlab_rtc.handlers
+.. automodule:: jupyterlab_collaboration.handlers
   :members:
   :inherited-members:

docs/source/index.md

@@ -11,18 +11,18 @@ contain the root `toctree` directive.
 From JupyterLab v4, file documents and notebooks have collaborative
 editing using the [Yjs shared editing framework](https://github.com/yjs/yjs).
 Editors are not collaborative by default; to activate it, install the extension
-`jupyterlab_rtc`.
+`jupyterlab_collaboration`.
 
 Installation using mamba/conda:
 
 ```sh
-mamba install -c conda-forge jupyterlab_rtc
+mamba install -c conda-forge jupyterlab_collaboration
 ```
 
 Installation using pip:
 
 ```sh
-pip install jupyterlab_rtc
+pip install jupyterlab_collaboration
 ```
 
 To share a document with other users, you can copy the URL and send it, or you

install.json

@@ -1,5 +1,5 @@
 {
   "packageManager": "python",
-  "packageName": "jupyterlab_rtc",
-  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyterlab_rtc"
+  "packageName": "jupyterlab_collaboration",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyterlab_collaboration"
 }

jupyter-config/jupyter_server.json → jupyter-config/jupyterlab_collaboration.json

@@ -1,7 +1,7 @@
 {
   "ServerApp": {
     "jpserver_extensions": {
-      "jupyterlab_rtc": true
+      "jupyterlab_collaboration": true
     }
   }
 }

jupyterlab_rtc/__init__.py → jupyterlab_collaboration/__init__.py

@@ -5,8 +5,8 @@
 
 
 def _jupyter_labextension_paths():
-    return [{"src": "labextension", "dest": "@jupyterlab/rtc-extension"}]
+    return [{"src": "labextension", "dest": "@jupyterlab/collaboration-extension"}]
 
 
 def _jupyter_server_extension_points() -> List[Dict[str, Any]]:
-    return [{"module": "jupyterlab_rtc", "app": YDocExtension}]
+    return [{"module": "jupyterlab_collaboration", "app": YDocExtension}]

jupyterlab_rtc/app.py → jupyterlab_collaboration/app.py

@@ -13,7 +13,7 @@
 
 
 class YDocExtension(ExtensionApp):
-    name = "jupyterlab_rtc"
+    name = "jupyterlab_collaboration"
 
     file_poll_interval = Int(
         1,

package.json

@@ -8,13 +8,13 @@
     "jupyterlab",
     "jupyterlab-extension"
   ],
-  "homepage": "https://github.com/jupyterlab/jupyterlab_rtc",
+  "homepage": "https://github.com/jupyterlab/jupyterlab_collaboration",
   "bugs": {
-    "url": "https://github.com/jupyterlab/jupyterlab_rtc/issues"
+    "url": "https://github.com/jupyterlab/jupyterlab_collaboration/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jupyterlab/jupyterlab_rtc.git"
+    "url": "https://github.com/jupyterlab/jupyterlab_collaboration.git"
   },
   "license": "BSD-3-Clause",
   "author": {

packages/rtc-extension/README.md → packages/collaboration-extension/README.md

@@ -1,3 +1,3 @@
-# @jupyterlab/rtc-extension
+# @jupyterlab/collaboration-extension
 
 A JupyterLab package which provides a set of plugins for Real Time Collaboration.

packages/rtc-extension/package.json → packages/collaboration-extension/package.json

@@ -1,19 +1,19 @@
 {
-  "name": "@jupyterlab/rtc-extension",
+  "name": "@jupyterlab/collaboration-extension",
   "version": "4.0.0-alpha.19",
   "description": "JupyterLab - RTC Extension",
   "keywords": [
     "jupyter",
     "jupyterlab",
     "jupyterlab-extension"
   ],
-  "homepage": "https://github.com/jupyterlab/jupyterlab_rtc",
+  "homepage": "https://github.com/jupyterlab/jupyterlab_collaboration",
   "bugs": {
-    "url": "https://github.com/jupyterlab/jupyterlab_rtc/issues"
+    "url": "https://github.com/jupyterlab/jupyterlab_collaboration/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jupyterlab/jupyterlab_rtc.git"
+    "url": "https://github.com/jupyterlab/jupyterlab_collaboration.git"
   },
   "license": "BSD-3-Clause",
   "author": "Project Jupyter",
@@ -44,7 +44,7 @@
     "build:labextension:dev": "jupyter labextension build --development True .",
     "clean": "jlpm run clean:lib",
     "clean:lib": "rimraf lib tsconfig.tsbuildinfo node_modules",
-    "clean:labextension": "rimraf ../../jupyterlab_rtc/labextension",
+    "clean:labextension": "rimraf ../../jupyterlab_collaboration/labextension",
     "clean:all": "jlpm run clean:lib && jlpm run clean:labextension",
     "install:extension": "jlpm run build",
     "watch": "run-p watch:src watch:labextension",
@@ -81,13 +81,13 @@
   "typedoc": {
     "entryPoint": "./src/index.ts",
     "readmeFile": "./README.md",
-    "displayName": "@jupyterlab/rtc-extension",
+    "displayName": "@jupyterlab/collaboration-extension",
     "tsconfig": "./tsconfig.json"
   },
   "jupyterlab": {
     "extension": true,
     "schemaDir": "./schema",
-    "outputDir": "../../jupyterlab_rtc/labextension",
+    "outputDir": "../../jupyterlab_collaboration/labextension",
     "disabledExtensions": [
       "@jupyterlab/filebrowser-extension:defaultFileBrowser"
     ],

packages/rtc-extension/src/collaboration.ts → packages/collaboration-extension/src/collaboration.ts

@@ -36,7 +36,7 @@ import { WebsocketProvider } from 'y-websocket';
  * Jupyter plugin providing the IUserMenu.
  */
 export const userMenuPlugin: JupyterFrontEndPlugin<IUserMenu> = {
-  id: '@jupyterlab/rtc-extension:userMenu',
+  id: '@jupyterlab/collaboration-extension:userMenu',
   autoStart: true,
   requires: [],
   provides: IUserMenu,
@@ -51,7 +51,7 @@ export const userMenuPlugin: JupyterFrontEndPlugin<IUserMenu> = {
  * Jupyter plugin adding the IUserMenu to the menu bar if collaborative flag enabled.
  */
 export const menuBarPlugin: JupyterFrontEndPlugin<void> = {
-  id: '@jupyterlab/rtc-extension:userMenuBar',
+  id: '@jupyterlab/collaboration-extension:userMenuBar',
   autoStart: true,
   requires: [IUserMenu],
   activate: async (app: JupyterFrontEnd, menu: IUserMenu): Promise<void> => {
@@ -80,7 +80,7 @@ export const menuBarPlugin: JupyterFrontEndPlugin<void> = {
  * Jupyter plugin creating a global awareness for RTC.
  */
 export const rtcGlobalAwarenessPlugin: JupyterFrontEndPlugin<IAwareness> = {
-  id: '@jupyterlab/rtc-extension:rtcGlobalAwareness',
+  id: '@jupyterlab/collaboration-extension:rtcGlobalAwareness',
   autoStart: true,
   requires: [IStateDB],
   provides: IGlobalAwareness,
@@ -129,7 +129,7 @@ export const rtcGlobalAwarenessPlugin: JupyterFrontEndPlugin<IAwareness> = {
  * Jupyter plugin adding the RTC information to the application left panel if collaborative flag enabled.
  */
 export const rtcPanelPlugin: JupyterFrontEndPlugin<void> = {
-  id: '@jupyterlab/rtc-extension:rtcPanel',
+  id: '@jupyterlab/collaboration-extension:rtcPanel',
   autoStart: true,
   requires: [IGlobalAwareness, ITranslator],
   activate: (

packages/rtc-extension/src/filebrowser.ts → packages/collaboration-extension/src/filebrowser.ts

@@ -25,7 +25,7 @@ namespace CommandIDs {
  * The default file browser factory provider.
  */
 export const defaultFileBrowser: JupyterFrontEndPlugin<IDefaultFileBrowser> = {
-  id: '@jupyterlab/rtc-extension:defaultFileBrowser',
+  id: '@jupyterlab/collaboration-extension:defaultFileBrowser',
   provides: IDefaultFileBrowser,
   requires: [IFileBrowserFactory],
   optional: [IRouter, JupyterFrontEnd.ITreeResolver, ILabShell],
@@ -36,7 +36,9 @@ export const defaultFileBrowser: JupyterFrontEndPlugin<IDefaultFileBrowser> = {
     tree: JupyterFrontEnd.ITreeResolver | null,
     labShell: ILabShell | null
   ): Promise<IDefaultFileBrowser> => {
-    console.debug('@jupyterlab/rtc-extension:defaultFileBrowser: activated');
+    console.debug(
+      '@jupyterlab/collaboration-extension:defaultFileBrowser: activated'
+    );
     const { commands } = app;
 
     const drive = new YDrive(app.serviceManager.user);

packages/rtc-extension/src/index.ts → packages/collaboration-extension/src/index.ts

@@ -2,7 +2,7 @@
 // Distributed under the terms of the Modified BSD License.
 /**
  * @packageDocumentation
- * @module rtc-extension
+ * @module collaboration-extension
  */
 
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';

packages/collaboration/package.json

@@ -2,13 +2,13 @@
   "name": "@jupyterlab/collaboration",
   "version": "4.0.0-alpha.19",
   "description": "JupyterLab - Real Time Collaboration Widgets",
-  "homepage": "https://github.com/jupyterlab/jupyterlab_rtc",
+  "homepage": "https://github.com/jupyterlab/jupyterlab_collaboration",
   "bugs": {
-    "url": "https://github.com/jupyterlab/jupyterlab_rtc/issues"
+    "url": "https://github.com/jupyterlab/jupyterlab_collaboration/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jupyterlab/jupyterlab_rtc.git"
+    "url": "https://github.com/jupyterlab/jupyterlab_collaboration.git"
   },
   "license": "BSD-3-Clause",
   "author": "Project Jupyter",