A JupyterLab plugin to facilitate invocation of code formatters.

Navigation

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics
Maintainers
Avatar for ryantam626 from gravatar.com ryantam626

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (Copyright 2023 Ryan TAM Permission is hereby granted, free of charge, to any person obtaining a cop...)
  • Author: Ryan Tam
  • Requires: Python >=3.7
  • Provides-Extra: dev , test
Classifiers
Report project as malware

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 .

Supported by

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