README.md

message_replay

Restore Notebook execution progress when a browser page is reloaded

See jupyter-server/team-compass#52 to learn about how this repository came into existence.

Requirements

• Jupyter Server

Install

To install the extension, execute:

pip install message_replay

Uninstall

To remove the extension, execute:

pip uninstall message_replay

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

Contributing

Development install

# Clone the repo to your local environment
# Change directory to the message_replay directory
# Install package in development mode - will automatically enable
# The server extension.
pip install -e .

You can watch the source directory and run your Jupyter Server-based application at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension. For example, when running JupyterLab:

jupyter lab --autoreload

If your extension does not depend a particular frontend, you can run the server directly:

jupyter server --autoreload

Running Tests

Install dependencies:

pip install -e ".[test]"

To run the python tests, use:

pytest

# To test a specific file
pytest message_replay/tests/test_handlers.py

# To run a specific test
pytest message_replay/tests/test_handlers.py -k "test_get"

Development uninstall

pip uninstall message_replay

Packaging the extension

See RELEASE