jupyterlab-code-formatter (original) (raw)

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 .

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

File details

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

File metadata

File hashes

Hashes for jupyterlab_code_formatter-3.0.2.tar.gz | Algorithm | Hash digest | | | ----------- | ---------------------------------------------------------------- | | | SHA256 | 55adb8fa8b9bd58f0b39e7d3ead6c1e862e9ebc1444a66cdb4233d8dc6351d4b | | | MD5 | 924d89ac0400a72b09789dd6acf1fa08 | | | BLAKE2b-256 | eaa0279f8ab354f944cd54fc124eeb6112f4d4fd22c6834e96ca48a13bc015a4 | |

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyterlab_code_formatter-3.0.2-py3-none-any.whl | Algorithm | Hash digest | | | ----------- | ---------------------------------------------------------------- | | | SHA256 | 9f4c5be0a5296029207d965da7b65621aa8a06d39fc3a5d8e59d1f3db88997fd | | | MD5 | f19fed89502d0a095d7e0b486b894144 | | | BLAKE2b-256 | 7b82198e37071ca3f5709b80b19d99b5498f75f020e9052b8f7f750bd3580ad6 | |

See more details on using hashes here.