Skip to main content

jupyterlab-cell-diff

Github Actions Status

A JupyterLab extension for showing cell diffs with multiple diffing strategies.

Requirements

  • JupyterLab >= 4.0.0

Installation

PyPI Installation

pip install jupyterlab_cell_diff

Development Installation

# Clone the repository
git clone https://github.com/jupyter-ai-contrib/jupyterlab-cell-diff.git
cd jupyterlab-cell-diff

# Install the extension in development mode
pip install -e .
jupyter labextension develop . --overwrite

Usage

Commands

The extension provides a command to show cell diffs:

  • jupyterlab-cell-diff:show-codemirror - Show diff using @codemirror/merge

https://github.com/user-attachments/assets/0dacd7f0-5963-4ebe-81da-2958f0117071

Programmatic Usage

app.commands.execute('jupyterlab-cell-diff:show-codemirror', {
  cellId: 'cell-id',
  originalSource: 'print("Hello")',
  newSource: 'print("Hello, World!")'
});

Command Arguments

The jupyterlab-cell-diff:show-codemirror command accepts the following arguments:

Argument Type Required Description
cellId string No ID of the cell to show diff for. If not provided, uses the active cell
originalSource string Yes Original source code to compare against
newSource string Yes New source code to compare with
showActionButtons boolean No Whether to show action buttons in the diff widget (default: true)
notebookPath string No Path to the notebook containing the cell. If not provided, uses the current notebook
openDiff boolean No Whether to open the diff widget automatically (default: true)

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_cell_diff

Troubleshoot

To check the frontend extension is installed:

jupyter labextension list

Metadata

Release files for jupyterlab-cell-diff 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyterlab-cell-diff 0.5.1
File Size Uploaded
jupyterlab_cell_diff-0.5.1.tar.gz 159.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jupyterlab-cell-diff 0.5.1
File Interpreter ABI Platform
jupyterlab_cell_diff-0.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 250.8 kB

Release files / jupyterlab_cell_diff-0.5.1.tar.gz

Download URL jupyterlab_cell_diff-0.5.1.tar.gz
Size 159.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1ec08b0d1595a5f7672b3cf8af239444d42b056335d49bc476a4dadfb63ba298
BLAKE2b-256 checksum
How to use checksums
173b4355bc223728f1951e385d0b87080710d11e9e8ccc298bdc33bd5dbeee5f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.2.0 CPython/3.12.11

Release files / jupyterlab_cell_diff-0.5.1-py3-none-any.whl

Download URL jupyterlab_cell_diff-0.5.1-py3-none-any.whl
Size 91.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
33d6f00c1d06ae8cd6135bc80d939e3dd62e64c153e1728ba2af8b5d0f614f01
BLAKE2b-256 checksum
How to use checksums
bd7bbcaa1edc3c32e9ba501ab8a395dcd93b022153f7a3b058b73f5928bc77b5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.2.0 CPython/3.12.11

Release history Release notifications | RSS feed

This release

0.5.1 This release

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page