jupyter-ruff

A JupyterLab and Jupyter Notebook extension for formatting code with Ruff.

Requirements

One of the following:

• JupyterLab >= 4.0.0
• Jupyter Notebook >= 7.0.0

Usage

An interactive environment to try out this extension is available on Binder. Alternatively, learn how to use this extension by reading the Demo.ipynb notebook.

If you are familiar with nb_black, this extension can provide a similar mode of operation where cells are formatted as they are executed. However, you also have the option to just format cells using menus, keyboard shortcuts, the command palette, or format on save.

You may also consult the Ruff documentation to learn about the underlying formatting rules.

Install

To install the extension, execute one of the following:

pip install jupyter-ruff
mamba install jupyter-ruff -c conda-forge

To remove the extension, execute one of the following:

pip uninstall jupyter-ruff
mamba remove jupyter-ruff

Alternatively, you can also use the builtin JupyterLab extension manager to install the extension.

Contributing

All good-faith contributions are welcome! Please read CONTRIBUTING for information on how to set up a development environment and perform common development tasks.