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
Release files for jupyterlab-code-formatter 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jupyterlab_code_formatter-3.1.0.tar.gz | 3.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jupyterlab_code_formatter-3.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.3 MB
Release files / jupyterlab_code_formatter-3.1.0.tar.gz
| Download URL | jupyterlab_code_formatter-3.1.0.tar.gz |
|---|---|
| Size | 3.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6d28a0f7e1a7013f35e1c7f47c09e21f56a2947e5760a5abbb792696fdb27023
|
|
BLAKE2b-256 checksum How to use checksums |
8c518c62c99005489d00aaf755da5095df1ec74531fb1243f00149807a83c55f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
Release files / jupyterlab_code_formatter-3.1.0-py3-none-any.whl
| Download URL | jupyterlab_code_formatter-3.1.0-py3-none-any.whl |
|---|---|
| Size | 38.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c1d9a8e3b31e13493281636ccfc18d69debd476487a26d3bf6a03debb80fdfb8
|
|
BLAKE2b-256 checksum How to use checksums |
a1c0b57940ad6f217be80bb66f9d942d33d9349ae75cd1b0fe1118bc40cdae25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.13
|
