A Jupyter Server Session Manager that rehydrates and synchronizes Jupyter sessions (e.g. notebook-kernel connections).
Project description
Jupyter Server Synchronizer
A Jupyter Server Session Manager that persists and rehydrates kernel sessions beyond the lifetime of a server.
This is particularly useful for Jupyter Servers running remote kernels and contents.
Basic usage
Install and enable the extension:
pip install jupyter_server_synchronizer
jupyter server extension enable jupyter_server_synchronizer
When you start a Jupyter Server, it synchronize all managers before the Web application is started.
jupyter server --ServerApp.session_manager_class=jupyter_server_synchronizer.SynchronizerSessionManager
To synchronize periodically, enable the auto-synchronizing feature using the autosync
config option. For example,
jupyter server --ServerApp.session_manager_class=jupyter_server_synchronizer.SynchronizerSessionManager --SynchronizerSessionManager.autosync=True
Otherwise, you can trigger the synchronization making a POST
request to the /api/sync
endpoint.
Example
Below is a example of running the synchronizer with Jupyter Server talking to a Jupyter Kernel Gateway as its "remote" kernel service provider.
First, start the Kernel Gateway. You'll need to enable the list_kernels
method. In the example, we are assuming the Kernel Gateway is not multi-tenant; i.e. there is a single KG for a single Jupyter Server. We'll set the port to 9999
to free up 8888
for our Jupyter Server.
jupyter kernelgateway \
--port 9999 \
--JupyterWebsocketPersonality.list_kernels=True
Second, start the Jupyter Server and point it at the Kernel Gateway. Note that we set a database_filepath
trait in both the SessionManager
and SynchronizerExtension
(these paths don't need to be the same). The Synchronize relies on saving/storing of information about Jupyter kernels and sessions in a persistent database. This information is necessary to rehydrate and synchronize.
We'll enable the "autosync" feature to periodically synchronize the server.
jupyter lab \
--gateway-url=http://127.0.0.1:9999 \
--ServerApp.session_manager_class=jupyter_server_synchronizer.SynchronizerSessionManager
--SynchronizerSessionManager.database_filepath=jupyter-database.db \
--SynchronizerSessionManager.autosync=True \
--SynchronizerSessionManager.log_level=DEBUG
Now, let's kill that server:
kill -9 $(echo $(pgrep -lf jupyter-lab) | awk '{print $1;}')
And restart it to see if the kernels rehydrate and begin synchronizing again.
jupyter lab \
--gateway-url=http://127.0.0.1:9999 \
--ServerApp.session_manager_class=jupyter_server_synchronizer.SynchronizerSessionManager
--SessionManager.database_filepath=jupyter-database.db \
--SynchronizerSessionManager.autosync=True \
--SynchronizerSessionManager.log_level=DEBUG
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyter_server_synchronizer-0.0.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 567198c56b787dd186c61c37d24a667165707d26eada2bedfe5466eb81e5ec31 |
|
MD5 | ee8b8988ec318f289f964e81dc167c7b |
|
BLAKE2b-256 | 43f29560fcebaf15275ca66c918f0c8cecc89c4baec090927eaef0260ac7731f |
Hashes for jupyter_server_synchronizer-0.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a05a4924d7c1a9807a8b725de6732ef485f58a34859258e64363ad7c0818ae56 |
|
MD5 | 791ab6d0388a72c106f11eb424ffff3f |
|
BLAKE2b-256 | 1c5efca82829689e8a4463c29f416cececd8bbb55cfaccfe463cf32082254b11 |