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.3.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyterlab_code_formatter-3.0.3-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jupyterlab_code_formatter-3.0.3.tar.gz
Algorithm Hash digest
SHA256 179e3c85cf6c0fc3c321c84bae446f3a2ad517e26606989c9485ce72e6c781c5
MD5 2493294f88ca2b06c3b6eedfa3a04f94
BLAKE2b-256 e705a4115d428c07e70c8fef8790f234afb8ec5d31537f6ef643748b85c89759

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyterlab_code_formatter-3.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e10de34012c8acd935a7781980e629e3cb7635967d83e03ca662c844b23a91d8
MD5 38aa4c2f69fcda517f6ad4852c3af27d
BLAKE2b-256 59a18de7afd92c475f7ed5487a8070fb69c869039ec0aef46ef11543b86bbef4

See more details on using hashes here.

Supported by

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