Split up the backend, frontend, and the docprovider (#280)

* Split up the backend, frontend, and the docprovider

* Fix LICENSE issue

* Try a different way

* Include LICENSE copies in git for simplicity

* Test creating sdist for projects, not the root metapackage

* Without concurrency

* Fix sdist install

* Include tests in `jupyter-server-ydoc`

* Move test dependencies, align indent

* Fix module name

* Hopefully final test to sdist test

* Only run pytest where needed

* Add Python 3.12 version classifier

Co-authored-by: David Brochart <[email protected]>

* Implement independent version bumps, and minor/major/release specifiers

* Bump all version to 3.0.0-alpha.0

* Reset versions for the three Python packages to 1.0.0a0

* Improve wording

Co-authored-by: David Brochart <[email protected]>

* Raise rather than assert

---------

Co-authored-by: David Brochart <[email protected]>

Author: krassowski

.github/workflows/test.yml

@@ -114,7 +114,7 @@ jobs:
       - name: Run the tests with Coverage
         if: ${{ !startsWith(matrix.python-version, 'pypy') && !startsWith(runner.os, 'Windows') }}
         run: |
-          python -m pytest -vv --cov jupyter_collaboration --cov-branch --cov-report term-missing:skip-covered
+          python -m pytest -vv --cov jupyter_server_ydoc --cov-branch --cov-report term-missing:skip-covered
 
       #- name: Run the tests on pypy
       #  if: ${{ startsWith(matrix.python-version, 'pypy') }}
@@ -126,7 +126,7 @@ jobs:
       - name: Run the tests on Windows
         if: ${{ startsWith(runner.os, 'Windows') }}
         run: |
-          python -W ignore::ImportWarning -m pytest -vv --cov jupyter_collaboration --cov-branch --cov-report term-missing:skip-covered
+          python -W ignore::ImportWarning -m pytest -vv --cov jupyter_server_ydoc --cov-branch --cov-report term-missing:skip-covered
 
       - uses: jupyterlab/maintainer-tools/.github/actions/upload-coverage@v1
 
@@ -136,7 +136,7 @@ jobs:
         run: |
           set -eux
           jupyter server extension list
-          jupyter server extension list 2>&1 | grep -ie "jupyter_collaboration.*OK"
+          jupyter server extension list 2>&1 | grep -ie "jupyter_server_ydoc.*OK"
           jupyter labextension list
           jupyter labextension list 2>&1 | grep -ie "@jupyter/collaboration-extension.*OK"
           python -m jupyterlab.browser_check
@@ -196,7 +196,15 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-      - uses: jupyterlab/maintainer-tools/.github/actions/make-sdist@v1
+      - name: Build SDist
+        shell: bash
+        run: |
+          pip install build
+          find projects/* -maxdepth 0 -type d | xargs -L 1 python -m build --sdist --outdir dist/
+      - uses: actions/upload-artifact@v3
+        with:
+          name: "sdist"
+          path: dist/*.tar.gz
 
   test_sdist:
     runs-on: ubuntu-latest
@@ -216,10 +224,11 @@ jobs:
           set -ex
           cd sdist
           mkdir test
-          tar --strip-components=1 -zxvf *.tar.gz -C ./test
+          find *.tar.gz | xargs -L 1 tar -C ./test -zxvf
           cd test
           python -m pip install "jupyterlab>=4.0.0,<5"
-          python -m pip install ".[test]"
+          # install each from source, except for `jupyter_collaboration` metapackage
+          find ./* -maxdepth 0 -type d -not -path './jupyter_collaboration-*' | sed 's/$/[test]/' | xargs -L 1 python -m pip install
           echo "::endgroup::"
 
       - name: Run Test
@@ -228,10 +237,14 @@ jobs:
           echo "::group::Run test"
           set -ex
           cd sdist/test
+
+          # for now only `jupyter_server_ydoc` includes python tests
+          cd jupyter_server_ydoc*
           python -m pytest -vv -raXxs --durations 10 --color=yes
+          cd ..
 
           jupyter server extension list
-          jupyter server extension list 2>&1 | grep -ie "jupyter_collaboration.*OK"
+          jupyter server extension list 2>&1 | grep -ie "jupyter_server_ydoc.*OK"
           jupyter labextension list
           jupyter labextension list 2>&1 | grep -ie "@jupyter/collaboration-extension.*OK"
           python -m jupyterlab.browser_check --no-browser-test

.gitignore

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

.licenserc.yaml

@@ -24,5 +24,6 @@ header:
     - 'coverage'
     - 'LICENSE'
     - 'yarn.lock'
+    - '**/_version.py'
 
   comment: on-failure

.pre-commit-config.yaml

@@ -60,7 +60,7 @@ repos:
     rev: v0.991
     hooks:
       - id: mypy
-        exclude: "^binder/jupyter_config\\.py$"
+        exclude: "(^binder/jupyter_config\\.py$)|(/setup\\.py$)"
         args: ["--config-file", "pyproject.toml"]
         additional_dependencies: [tornado, pytest]
         stages: [manual]

README.md

@@ -1,6 +1,9 @@
 # Jupyter Real-Time Collaboration
 
-[![Build Status](https://github.com/jupyterlab/jupyter_collaboration/actions/workflows/test.yml/badge.svg?query=branch%3Amain++)](https://github.com/jupyterlab/jupyter_collaboration/actions?query=branch%3Amain++)[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyter_collaboration/main)[![PyPI](https://img.shields.io/pypi/v/jupyter-collaboration)](https://pypi.org/project/jupyter-collaboration)[![npm](https://img.shields.io/npm/v/@jupyter/collaboration-extension)](https://www.npmjs.com/package/@jupyter/collaboration-extension)
+[![Build Status](https://github.com/jupyterlab/jupyter_collaboration/actions/workflows/test.yml/badge.svg?query=branch%3Amain++)](https://github.com/jupyterlab/jupyter_collaboration/actions?query=branch%3Amain++)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab/jupyter_collaboration/main)
+[![PyPI](https://img.shields.io/pypi/v/jupyter-collaboration)](https://pypi.org/project/jupyter-collaboration)
+[![npm](https://img.shields.io/npm/v/@jupyter/collaboration-extension)](https://www.npmjs.com/package/@jupyter/collaboration-extension)
 
 JupyterLab Real-Time Collaboration is a Jupyter Server Extension and JupyterLab extensions providing support for [Y documents](https://github.com/jupyter-server/jupyter_ydoc) and adding collaboration UI elements in JupyterLab.
 

RELEASE.md

@@ -1,5 +1,20 @@
-# Making a Jupyter Server Release
+# Making a jupyter-collaboration Release
 
 ## Using `jupyter_releaser`
 
 The recommended way to make a release is to use [`jupyter_releaser`](https://github.com/jupyter-server/jupyter_releaser#checklist-for-adoption).
+
+## Version specification
+
+Here is an example of how version numbers progress through a release process.
+Input appropriate specifier into the `jupyter-releaser` workflow dispatch dialog to bump version numbers for this release.
+
+| Command   | Python Version Change | NPM Version change                 |
+| --------- | --------------------- | ---------------------------------- |
+| `major`   | x.y.z-> (x+1).0.0.a0  | All a.b.c -> a.(b+10).0-alpha.0    |
+| `minor`   | x.y.z-> x.(y+1).0.a0  | All a.b.c -> a.(b+1).0-alpha.0     |
+| `build`   | x.y.z.a0-> x.y.z.a1   | All a.b.c-alpha.0 -> a.b.c-alpha.1 |
+| `release` | x.y.z.a1-> x.y.z.b0   | All a.b.c-alpha.1 -> a.b.c-beta.0  |
+| `release` | x.y.z.b1-> x.y.z.rc0  | All a.b.c-beta.1 -> a.b.c-rc.0     |
+| `release` | x.y.z.rc0-> x.y.z     | All a.b.c-rc0 -> a.b.c             |
+| `patch`   | x.y.z -> x.y.(z+1)    | Changed a.b.c -> a.b.(c+1)         |

docs/source/developer/contributing.rst

@@ -39,8 +39,13 @@ steps:
     pip install --upgrade pip
     git clone https://github.com/jupyterlab/jupyter_collaboration
     cd jupyter_collaboration
+    # install monorepo
     pip install -e ".[dev,test]"
-    jupyter labextension develop --overwrite .
+    # install local dependencies as editable
+    pip install -e projects/jupyter-collaboration-ui -e projects/jupyter-docprovider -e projects/jupyter-server-ydoc
+    # link lab extensions
+    jupyter labextension develop --overwrite projects/jupyter-collaboration-ui
+    jupyter labextension develop --overwrite projects/jupyter-docprovider
 
 
 If you are using a system-wide Python installation and you only want to install the server for you,

docs/source/developer/python_api.rst

@@ -4,14 +4,14 @@
 Python API
 ==========
 
-``jupyter_collaboration`` instantiates :any:`YDocExtension` and stores it under ``serverapp.settings`` dictionary, under the ``"jupyter_collaboration"`` key.
+``jupyter_server_ydoc`` instantiates :any:`YDocExtension` and stores it under ``serverapp.settings`` dictionary, under the ``"jupyter_server_ydoc"`` key.
 This instance can be used in other extensions to access the public API methods.
 
 For example, to access a read-only view of the shared notebook model in your jupyter-server extension, you can use the :any:`get_document` method:
 
 .. code-block::
 
-   collaboration = serverapp.settings["jupyter_collaboration"]
+   collaboration = serverapp.settings["jupyter_server_ydoc"]
    document = collaboration.get_document(
        path='Untitled.ipynb',
        content_type="notebook",
@@ -23,10 +23,10 @@ For example, to access a read-only view of the shared notebook model in your jup
 API Reference
 -------------
 
-.. automodule:: jupyter_collaboration.app
+.. automodule:: jupyter_server_ydoc.app
   :members:
   :inherited-members:
 
-.. automodule:: jupyter_collaboration.handlers
+.. automodule:: jupyter_server_ydoc.handlers
   :members:
   :inherited-members:

lerna.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.11",
+  "version": "3.0.0-alpha.0",
   "npmClient": "yarn",
   "useWorkspaces": true
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jupyter/real-time-collaboration",
   "private": true,
-  "version": "2.0.11",
+  "version": "3.0.0-alpha.0",
   "description": "JupyterLab Extension enabling Real-Time Collaboration",
   "keywords": [
     "jupyter",
@@ -66,4 +66,4 @@
     "typedoc": "~0.23.28",
     "typescript": "~5.0.4"
   }
-}
+}