JupyterLab Code Formatter

A JupyterLab plugin to facilitate invocation of code formatters.

Source Code: GitHub.

Demo

Requirements

• Python 3.7+

• JupyterLab >= 3.6.0 (if you are using JupyterLab>=3.0,<=3.5, pin this package to 2.0.0)

• Any supported code formatters (you can also specify your own, see custom formatter).

Important

JupyterLab Code Formatter only provides an interface for invoking code formatters on Jupyter Server, and does not include any code formatter by default.

Quick Start

1. Install the package

Pip

pip install jupyterlab-code-formatter

Poetry

poetry add jupyterlab-code-formatter

Pipenv

pipenv install jupyterlab-code-formatter

2. Install some supported formatters (isort+black are default for Python)

Pip

# NOTE: Install black and isort,
#       JL code formatter is configured to invoke isort and black by default
pip install black isort

Poetry

# NOTE: Install black and isort,
#       JL code formatter is configured to invoke isort and black by default
poetry add black isort

Pipenv

# NOTE: Install black and isort,
#       JL code formatter is configured to invoke isort and black by default
pipenv install black isort

3. Restart JupyterLab

This plugin includes a server plugin, as suck you will need to restart JupyterLab if you have followed the above steps while it’s running.

4. Configure plugin

To configure which/how formatters are invoked, see configuration.