https://github.com/jupyter-server/message_replay
Solving the (missed) kernel message problem
https://github.com/jupyter-server/message_replay
Last synced: about 1 month ago
JSON representation
Solving the (missed) kernel message problem
- Host: GitHub
- URL: https://github.com/jupyter-server/message_replay
- Owner: jupyter-server
- License: bsd-3-clause
- Created: 2023-07-06T15:54:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T18:47:05.000Z (about 2 months ago)
- Last Synced: 2025-05-12T14:37:30.658Z (about 1 month ago)
- Language: Python
- Size: 16.6 KB
- Stars: 0
- Watchers: 8
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# message_replay
[](https://github.com/jupyter-server/message_replay/actions/workflows/build.yml)
Restore Notebook execution progress when a browser page is reloaded
See https://github.com/jupyter-server/team-compass/issues/52 to learn about how this repository came into existence.
## Requirements
- Jupyter Server
## Install
To install the extension, execute:
```bash
pip install message_replay
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall message_replay
```
## Troubleshoot
If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:
```bash
jupyter server extension list
```
## Contributing
### Development install
```bash
# 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:
```bash
jupyter lab --autoreload
```
If your extension does not depend a particular frontend, you can run the
server directly:
```bash
jupyter server --autoreload
```
### Running Tests
Install dependencies:
```bash
pip install -e ".[test]"
```
To run the python tests, use:
```bash
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
```bash
pip uninstall message_replay
```
### Packaging the extension
See [RELEASE](RELEASE.md)