Skip to main content

A JupyterLab plugin to facilitate invocation of code formatters.

Project description

Extension status GitHub Action Status Binder pypi-version

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.

  1. Install the package
pip install jupyterlab-code-formatter
  1. 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
  1. Restart JupyterLab

This plugin includes a server plugin, restart JupyterLab if you have followed the above steps while it's running.

  1. Configure plugin

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


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 .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_code_formatter-3.0.1.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

File details

Details for the file jupyterlab_code_formatter-3.0.1.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_code_formatter-3.0.1.tar.gz
Algorithm Hash digest
SHA256 6806e482673bf00f43b9d4422e6029a4899a8f706630854cebf75b497b6c7194
MD5 1eee8b3b8a55d0b0ad2c20b9725975a1
BLAKE2b-256 c3eca546148a4be5d35cb817adb4fc4dd5c5f716041065b8676e7c3c92bedf30

See more details on using hashes here.

File details

Details for the file jupyterlab_code_formatter-3.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_code_formatter-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 582227daea9b36d0dcb1f6ba51bf38a44abc84ab9d05288adc2e3221b7d1ac69
MD5 02000a0c94aa666b182cd2980300b56d
BLAKE2b-256 de3be93d529119e180b43b5665be90e8dcf6c80938e4fdd45a55dab659aa2c0d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page