Changelog#

All notable changes to this project will be documented in this file.

3.0.0alpha2#

(Full Changelog)

Enhancements made#

Start ystore in a task #303 (@davidbrochart)

Bugs fixed#

Fix writing settings in page_config #304 (@fcollonval)

Maintenance and upkeep improvements#

Update JupyterLab 4.2.0 and fix test start store #305 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @fcollonval | @github-actions | @Zsailer

3.0.0alpha1#

(Full Changelog)

Enhancements made#

Log (instead of raise) exceptions when running as a server extension #295 (@Zsailer)
handle exception when websocket server start room failed #289 (@jzhang20133)

Bugs fixed#

Rename the docprovider destination name to avoid conficts #285 (@brichet)

Maintenance and upkeep improvements#

Update pycrdt-websocket v0.13.0 #293 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@brichet | @davidbrochart | @github-actions | @jzhang20133 | @Zsailer

3.0.0alpha0#

(Full Changelog)

Enhancements made#

Split up the backend, frontend, and the docprovider #280 (@krassowski)
Support server-side execution #279 (@davidbrochart)
Add a public API for getting a read-only view of the shared model #275 (@krassowski)

Maintenance and upkeep improvements#

Only include docprovider packages in its sdist #282 (@krassowski)
Workaround shutdown issue with aiosqlite for now #278 (@krassowski)
Fix UI tests #277 (@krassowski)

Contributors to this release#

(GitHub contributors page for this release)

@brichet | @davidbrochart | @ellisonbg | @github-actions | @jtpio | @krassowski | @Zsailer

2.0.11#

Enhancements made#

Make user’s cursor “tooltip-on-hover” faster and wider #259 (@jzhang20133)

Bugs fixed#

Fix releaser #268 (@davidbrochart)
Fix slow room opening #264 (@davidbrochart)
Use WebSocket _room_id attribute directly #266 (@davidbrochart)

2.0.10#

(Full Changelog)

Enhancements made#

Make user’s cursor “tooltip-on-hover” faster and wider #259 (@jzhang20133)

Bugs fixed#

Fix releaser #268 (@davidbrochart)
Fix slow room opening #264 (@davidbrochart)
Use WebSocket _room_id attribute directly #266 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

2.0.9#

(Full Changelog)

Enhancements made#

Make user’s cursor “tooltip-on-hover” faster and wider #259 (@jzhang20133)

Bugs fixed#

Fix slow room opening #264 (@davidbrochart)
Use WebSocket _room_id attribute directly #266 (@davidbrochart)

Maintenance and upkeep improvements#

Update Release Scripts #267 (@blink1073)

Contributors to this release#

(GitHub contributors page for this release)

@blink1073 | @davidbrochart | @github-actions | @welcome

2.0.8#

No merged PRs

2.0.7#

No merged PRs

2.0.6#

(Full Changelog)

Enhancements made#

Make user’s cursor “tooltip-on-hover” faster and wider #259 (@jzhang20133)

Bugs fixed#

Fix slow room opening #264 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @github-actions | @jzhang20133 | @Zsailer

2.0.5#

(Full Changelog)

Bugs fixed#

Fix concurrent room initialization #255 (@davidbrochart)

Maintenance and upkeep improvements#

Bump jupyter_events to 0.10.0 #258 (@Zsailer)
Fix concurrent room initialization #255 (@davidbrochart)
Add test for document dirty attribute #251 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @github-actions | @welcome | @Zsailer

2.0.4#

(Full Changelog)

Enhancements made#

adding awareness event when open and close websockets #246 (@jzhang20133)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @github-actions | @jzhang20133 | @welcome

2.0.3#

(Full Changelog)

Bugs fixed#

Fix cancellation of file save operation #241 (@davidbrochart)
Call get with options of type IFetchOptions #238 (@davidbrochart)

Maintenance and upkeep improvements#

Call get with options of type IFetchOptions #238 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @ellisonbg | @github-actions | @Zsailer

2.0.2#

(Full Changelog)

Enhancements made#

Handle last_modified only in FileLoader #232 (@davidbrochart)

Bugs fixed#

Handle last_modified only in FileLoader #232 (@davidbrochart)
Fix file saving #231 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @github-actions

2.0.1#

(Full Changelog)

Bugs fixed#

Revert PR #170 #228 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @davidbrochart | @github-actions

2.0.0#

(Full Changelog)

Enhancements made#

Adds a flag to disable RTC #177 (@hbcarlos)
Improves chat #173 (@hbcarlos)
Adds restore and ovewrite messages #170 (@hbcarlos)

Bugs fixed#

Improves error handling when the file does not exist #175 (@hbcarlos)
Use fileId instead of path in the store #174 (@hbcarlos)
Adds restore and ovewrite messages #170 (@hbcarlos)

Maintenance and upkeep improvements#

Fix CI #221 (@davidbrochart)
Use pycrdt-websocket instead of ypy-websocket #220 (@davidbrochart)
Switch from hub to gh CLI #199 (@hbcarlos)
Pin jupyter_events #186 (@hbcarlos)
Tests #182 (@hbcarlos)
Adds tests for rooms #181 (@hbcarlos)
Fix package name of integration tests #176 (@brichet)
Remove print #172 (@martinRenou)
Add UI-tests #157 (@brichet)

Documentation improvements#

Update README.md #212 (@1reverseengineer)
docs: 📝 update configuration doc #195 (@yambottle)

Contributors to this release#

(GitHub contributors page for this release)

@1reverseengineer | @brichet | @davidbrochart | @fcollonval | @github-actions | @hbcarlos | @krassowski | @martinRenou | @SylvainCorlay | @welcome | @yambottle

1.0.1#

(Full Changelog)

Enhancements made#

Support ypy-websocket v0.12 #168 (@davidbrochart)
Chat subprotocol #167 (@hbcarlos)

Maintenance and upkeep improvements#

Support ypy-websocket v0.12 #168 (@davidbrochart)
Fix npm tag for publication of final version #158 (@fcollonval)

Documentation improvements#

Remove link share mention #169 (@fcollonval)
Fix install instructions to use correct name #166 (@fperez)
Fix package name in README #159 (@fcollonval)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @davidbrochart | @fcollonval | @fperez | @github-actions | @hbcarlos

1.0.0#

(Full Changelog)

Maintenance and upkeep improvements#

Remove spurious ' #156 (@krassowski)

Contributors to this release#

(GitHub contributors page for this release)

1.0.0alpha9#

(Full Changelog)

Enhancements made#

Add share link feature #150 (@fcollonval)
Improve code architecture #146 (@fcollonval)
Add logger for file editor #145 (@fcollonval)
Emit events for collaborative sessions #139 (@hbcarlos)

Bugs fixed#

Support file types #154 (@hbcarlos)
Fix injecting user menu bar in top bar. #149 (@fcollonval)
Wait for the document to be synced #148 (@fcollonval)
Fix asyncio.Task type for python<=3.8 #143 (@davidbrochart)

Maintenance and upkeep improvements#

Fix binder env #152 (@fcollonval)
Add license to files automatically #147 (@fcollonval)
Add JavaScript and lab extension test in CI #144 (@fcollonval)
Fix asyncio.Task type for python<=3.8 #143 (@davidbrochart)
Update lab #141 (@hbcarlos)
Fix typo and punctuation #140 (@krassowski)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @davidbrochart | @fcollonval | @github-actions | @hbcarlos | @krassowski | @welcome

1.0.0alpha8#

(Full Changelog)

Enhancements made#

Follow up #133 #136 (@hbcarlos)
Creates a new FileLoader class to separate the logic of watching files #121 (@hbcarlos)

Bugs fixed#

Fix metadata #138 (@hbcarlos)

Maintenance and upkeep improvements#

Upgrade jupyter ydoc #135 (@fcollonval)

Documentation improvements#

Upgrade jupyter ydoc #135 (@fcollonval)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @davidbrochart | @fcollonval | @github-actions | @hbcarlos

1.0.0alpha7#

(Full Changelog)

Enhancements made#

Allow other extensions to register shared models #133 (@hbcarlos)

Maintenance and upkeep improvements#

Update dependencies #134 (@hbcarlos)

Contributors to this release#

(GitHub contributors page for this release)

@github-actions | @hbcarlos | @trungleduc

1.0.0alpha6#

(Full Changelog)

Bugs fixed#

Justify content in side panel #131 (@martinRenou)
Fix missing scrollbar when there are many collaborators #130 (@martinRenou)

Contributors to this release#

(GitHub contributors page for this release)

@github-actions | @martinRenou | @welcome

1.0.0alpha5#

(Full Changelog)

Enhancements made#

Removes deprecated endpoints #126 (@hbcarlos)
Display remote user cursors #122 (@fcollonval)

Bugs fixed#

Removes drive name from file path #127 (@hbcarlos)
Fix yarn on releaser #125 (@fcollonval)

Maintenance and upkeep improvements#

Bump dependencies #123 (@fcollonval)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @fcollonval | @github-actions | @hbcarlos

1.0.0alpha4#

(Full Changelog)

Enhancements made#

Save if the document has no provider #120 (@fcollonval)

Maintenance and upkeep improvements#

Fix pre-commit EOF error #119 (@fcollonval)
Remove a console.debug for plugin activate #118 (@jtpio)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @fcollonval | @github-actions | @jtpio

1.0.0alpha3#

(Full Changelog)

Bugs fixed#

Fixes experimental document-wide undo/redo flag #117 (@hbcarlos)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @hbcarlos

1.0.0alpha2#

(Full Changelog)

Bugs fixed#

Update ydoc #114 (@hbcarlos)
Creates document session #108 (@hbcarlos)
Keep reference to asyncio tasks #106 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @github-actions | @hbcarlos

1.0.0alpha1#

(Full Changelog)

Enhancements made#

Setup a monorepo with a JupyterLab extension #77 (@hbcarlos)
Move rtc packages #76 (@hbcarlos)

Bugs fixed#

Include style from dependencies #103 (@fcollonval)
Remove PageConfig #97 (@fcollonval)
Add missing argument for format string (#92) #93 (@cghanke)

Maintenance and upkeep improvements#

Bump dependencies #98 (@fcollonval)
Publish 1.0.0alpha0 #96 (@fcollonval)
Add releaser workflows #95 (@fcollonval)
Rename to jupyter_collaboration and @jupyter/collaboration #91 (@fcollonval)
Renames python package and lab extension #88 (@hbcarlos)
Drop pytest_tornasync #87 (@fcollonval)
Fix releaser job #82 (@fcollonval)

Documentation improvements#

Add binder #99 (@fcollonval)
Link to the jupyter_ydoc repo in README.md #90 (@jtpio)
Improve readme #86 (@fcollonval)
Improve the documentation #85 (@fcollonval)
Moves documentation from JupyterLab #84 (@hbcarlos)
Adds documentation #80 (@hbcarlos)
Update links #79 (@hbcarlos)

Contributors to this release#

(GitHub contributors page for this release)

@cghanke | @codecov | @codecov-commenter | @fcollonval | @hbcarlos | @jtpio | @pre-commit-ci | @welcome

1.0.0alpha0#

(Full Changelog)

Enhancements made#

Setup a monorepo with a JupyterLab extension #77 (@hbcarlos)
Move rtc packages #76 (@hbcarlos)

Bugs fixed#

Add missing argument for format string (#92) #93 (@cghanke)

Maintenance and upkeep improvements#

Add releaser workflows #95 (@fcollonval)
Rename to jupyter_collaboration and @jupyter/collaboration #91 (@fcollonval)
Renames python package and lab extension #88 (@hbcarlos)
Drop pytest_tornasync #87 (@fcollonval)
Fix releaser job #82 (@fcollonval)

Documentation improvements#

Link to the jupyter_ydoc repo in README.md #90 (@jtpio)
Improve readme #86 (@fcollonval)
Improve the documentation #85 (@fcollonval)
Moves documentation from JupyterLab #84 (@hbcarlos)
Adds documentation #80 (@hbcarlos)
Update links #79 (@hbcarlos)

Contributors to this release#

(GitHub contributors page for this release)

@cghanke | @codecov | @codecov-commenter | @fcollonval | @hbcarlos | @jtpio | @pre-commit-ci | @welcome

0.x#

The version prior to 1.0.0 were containing only the Jupyter Server backend code and were released under the name jupyter-server-ydoc.

0.7.0#

(Full Changelog)

Maintenance and upkeep improvements#

Update ydoc #75 (@hbcarlos)
Add target to document change callback #72 (@davidbrochart)
Ignore ImportWarning in PyPy tests #71 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@codecov | @davidbrochart | @hbcarlos | @pre-commit-ci

0.6.1#

(Full Changelog)

Enhancements made#

Allow to set SQLiteYStore’s database path and document time-to-live #66 (@davidbrochart)

Bugs fixed#

Allow to set SQLiteYStore’s database path and document time-to-live #66 (@davidbrochart)

Maintenance and upkeep improvements#

Contributors to this release#

(GitHub contributors page for this release)

@codecov | @davidbrochart | @pre-commit-ci

0.6.0#

(Full Changelog)

Enhancements made#

Remove metadata #64 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.5.1#

(Full Changelog)

Enhancements made#

Pass logger to YStore #63 (@davidbrochart)

Bugs fixed#

Revert #61 #62 (@davidbrochart)

Maintenance and upkeep improvements#

Contributors to this release#

(GitHub contributors page for this release)

@codecov | @davidbrochart | @pre-commit-ci

0.5.0#

(Full Changelog)

Bugs fixed#

Add base_url to routes #61 (@davidbrochart)

Maintenance and upkeep improvements#

Update ypy-websocket #59 (@hbcarlos)

Contributors to this release#

(GitHub contributors page for this release)

@codecov | @davidbrochart | @hbcarlos

0.4.0#

(Full Changelog)

Enhancements made#

Pass logger to YRoom, require ypy-websocket >=0.5.0 #58 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.3.0#

(Full Changelog)

Enhancements made#

Add monitor #55 (@davidbrochart)
Move configuration from JupyterLab #54 (@davidbrochart)

Bugs fixed#

Require jupyter_server_fileid #51 (@davidbrochart)

Maintenance and upkeep improvements#

Contributors to this release#

(GitHub contributors page for this release)

@codecov | @davidbrochart | @pre-commit-ci

0.2.0#

(Full Changelog)

Enhancements made#

Adds a new setting for saving document delay #46 (@hbcarlos)

Maintenance and upkeep improvements#

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @hbcarlos | @pre-commit-ci

0.1.14#

(Full Changelog)

Enhancements made#

Use Jupyter file ID service if installed #41 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.1.13#

(Full Changelog)

Enhancements made#

Don’t unobserve and observe again #39 (@davidbrochart)

Maintenance and upkeep improvements#

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @davidbrochart | @pre-commit-ci | @welcome

0.1.12#

(Full Changelog)

Enhancements made#

Maintenance and upkeep improvements#

Switch to hatch version #33 (@davidbrochart)
Update to YDoc 0.2 #32 (@hbcarlos)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @davidbrochart | @hbcarlos | @pre-commit-ci | @welcome

0.1.11#

(Full Changelog)

Enhancements made#

Implement filtering in on_message #25 (@davidbrochart)

Maintenance and upkeep improvements#

[pre-commit.ci] pre-commit autoupdate #24 (@pre-commit-ci)

Contributors to this release#

(GitHub contributors page for this release)

@codecov-commenter | @davidbrochart | @pre-commit-ci

0.1.10#

(Full Changelog)

Enhancements made#

Add TransientRoom #22 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.1.9#

(Full Changelog)

Bugs fixed#

Support Jupyter server base URL #20 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.1.8#

(Full Changelog)

Enhancements made#

Bump dependencies #18 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.1.7#

(Full Changelog)

Enhancements made#

Bump jupyter_ydoc=0.1.14 #16 (@davidbrochart)

Maintenance and upkeep improvements#

[pre-commit.ci] pre-commit autoupdate #15 (@pre-commit-ci)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @pre-commit-ci

0.1.6#

(Full Changelog)

Bugs fixed#

Fix typing for python <=3.8 #13 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.1.5#

(Full Changelog)

Enhancements made#

Save Y updates using YStore #2 (@davidbrochart)

Maintenance and upkeep improvements#

[pre-commit.ci] pre-commit autoupdate #11 (@pre-commit-ci)
[pre-commit.ci] pre-commit autoupdate #10 (@pre-commit-ci)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @pre-commit-ci | @welcome

0.1.4#

(Full Changelog)

Merged PRs#

Fix changelog #8 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.1.3#

0.1.2#

(Full Changelog)

Bugs fixed#

Fix jupyter_server import #5 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

0.1.1#

(Full Changelog)

Bugs fixed#

Remove docs link for now #3 (@davidbrochart)

Contributors to this release#

(GitHub contributors page for this release)

@davidbrochart | @welcome

0.1.0#