A JupyterLab plugin to facilitate invocation of code formatters.
Documentation: Hosted on ReadTheDocs
Demo
Quick Start
I recommend you going to the documentation site, but this should work too.
- Install the package
pip install jupyterlab-code-formatter
- Install some supported formatters (isort+black are default for Python)
# NOTE: Install black and isort,
# JL code formatter is configured to invoke isort and black by default
pip install black isort
- Restart JupyterLab
This plugin includes a server plugin, restart JupyterLab if you have followed the above steps while it's running.
- Configure plugin
To configure which/how formatters are invoked, see configuration.
Troubleshoot
This extension is composed of a Python package named jupyterlab_code_formatter
for the server extension and a NPM package named jupyterlab-code-formatter
for the frontend extension.
If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:
jupyter server extension list
If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:
jupyter labextension list
Getting help
If you don't use Discord then feel free to open a GitHub issue, do note I am a bit slower in responding in GitHub.
Your Support
I could really use your support in giving me a star on GitHub, recommending features or fixing bugs.
Contributors
This extension was originally developed and maintained by @ryantam626. Massive thanks to the below list of people who made past contributions to the project!
License
This project is licensed under the terms of the MIT LICENSE .
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jupyterlab_code_formatter-3.1.0.tar.gz.
File metadata
- Download URL: jupyterlab_code_formatter-3.1.0.tar.gz
- Upload date:
- Size: 3.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6d28a0f7e1a7013f35e1c7f47c09e21f56a2947e5760a5abbb792696fdb27023
|
|
| MD5 |
ebf8c452683a6b71e178438ef5b65f0f
|
|
| BLAKE2b-256 |
8c518c62c99005489d00aaf755da5095df1ec74531fb1243f00149807a83c55f
|
File details
Details for the file jupyterlab_code_formatter-3.1.0-py3-none-any.whl.
File metadata
- Download URL: jupyterlab_code_formatter-3.1.0-py3-none-any.whl
- Upload date:
- Size: 38.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c1d9a8e3b31e13493281636ccfc18d69debd476487a26d3bf6a03debb80fdfb8
|
|
| MD5 |
6e2440ae91667be32326e16d84c372de
|
|
| BLAKE2b-256 |
a1c0b57940ad6f217be80bb66f9d942d33d9349ae75cd1b0fe1118bc40cdae25
|
