jupyterlab-suggestions

GitHub Repo starsGithub Actions Status

A JupyterLab extension for suggesting changes

https://github.com/user-attachments/assets/5b944b39-562b-4d6e-b0e3-1e16b92224d1

Requirements

  • JupyterLab >= 4.0.0

Installation

To install the extension, use the following commands:

pip install jupyter-suggestions

By default, jupyter-suggestions uses notebook metadata to store suggestions. However, this approach has certain limitations:

  • Changes made to the suggested cell are not reflected in the suggestion widget.

  • Accepting a suggestion overwrites the content of the suggested cell.

To address these issues, you can install an additional package to utilize the forking capabilities of jupyter-collaboration.

pip install jupyter-suggestions-rtc

By using jupyter-collaboration as the backend for managing suggestions, the content of suggestions is merged directly into the suggested cell.

Contributing

jupyter-suggestions is an open-source project, and contributions are always welcome. If you would like to contribute to jupyter-suggestions, please fork the repository and submit a pull request.

See CONTRIBUTING for dev installation instructions.

License

jupyter-suggestions is licensed under the BSD 3-Clause License. See the LICENSE file for more information.