Metadata-Version: 2.1
Name: jupyter-server-synchronizer
Version: 0.0.2
Summary: A server extension for synching managers in a running Jupyter Server.
Home-page: https://jupyter-server-synchronizer.readthedocs.io
Author: Jupyter Development Team
Author-email: jupyter@googlegroups.com
License: UNKNOWN
Project-URL: Documentation, https://jupyter-server-synchronizer.readthedocs.io
Project-URL: Funding, https://numfocus.org/donate
Project-URL: Source, https://github.com/jupyter-server/synchronizer
Project-URL: Tracker, https://github.com/jupyter-server/synchronizer/issues
Keywords: ipython,jupyter
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: Development Status :: 5 - Production/Stable
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
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: COPYING.md

# Jupyter Server Synchronizer

A server extension that synchronizes all managers in a running Jupyter 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
```

To synchronize periodically, enable the auto-synchronizing feature using the `autosync` config option. For example,

```
jupyter server --SynchronizerExtension.autosync=True
```

Otherwise, you can trigger the synchronization making a `POST` request to the `/api/sync` endpoint.


