https://github.com/jupyterlab-contrib/jupyterlab_code_formatter

A JupyterLab plugin to facilitate invocation of code formatters.
https://github.com/jupyterlab-contrib/jupyterlab_code_formatter

autopep8 black code-formatter jupyterlab-extension jupyterlab-extensions python r yapf

Last synced: about 10 hours ago
JSON representation

A JupyterLab plugin to facilitate invocation of code formatters.

• Host: GitHub
• URL: https://github.com/jupyterlab-contrib/jupyterlab_code_formatter
• Owner: jupyterlab-contrib
• License: mit
• Created: 2018-08-12T20:50:17.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-14T09:15:31.000Z (5 months ago)
• Last Synced: 2024-07-14T09:21:29.358Z (5 months ago)
• Topics: autopep8, black, code-formatter, jupyterlab-extension, jupyterlab-extensions, python, r, yapf
• Language: Python
• Homepage:
• Size: 15.6 MB
• Stars: 823
• Watchers: 7
• Forks: 52
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• best-of-jupyter - GitHub - 15% open · ⏱️ 14.08.2024): (JupyterLab Extensions)

README

        
![](docs/logo.png)

[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/)

[![GitHub Action Status](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/actions/workflows/build.yml/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/actions/workflows/build.yml)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab_code_formatter/master?urlpath=lab)

[![pypi-version](https://img.shields.io/pypi/v/jupyterlab-code-formatter.svg)](https://python.org/pypi/jupyterlab-code-formatter)

_A JupyterLab plugin to facilitate invocation of code formatters._

---

Documentation: [Hosted on ReadTheDocs](https://jupyterlab-code-formatter.readthedocs.io/)

---

## Demo

![](docs/_static/format-all.gif)

---

## Quick Start

I recommend you going to the [documentation site](https://jupyterlab-code-formatter.readthedocs.io/#quick-start), but this should work too.

1. **Install the package**

```bash

pip install jupyterlab-code-formatter

```

2. **Install some supported formatters** (isort+black are default for Python)

```bash

# NOTE: Install black and isort,

#       JL code formatter is configured to invoke isort and black by default

pip install black isort

```

3. **Restart JupyterLab**

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

4. **Configure plugin**

To configure which/how formatters are invoked, see [configuration](https://jupyterlab-code-formatter.readthedocs.io/configuration.html).

---

## Getting help

If you don't use Discord then feel free to open a [GitHub issue](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/issues), 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.

- [Recommending features via GitHub Issues](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/issues)

- [Submitting your PR on GitHub](https://github.com/jupyterlab-contrib/jupyterlab_code_formatter/pulls)

---

## Contributors

This extension was originally developed and maintained by [@ryantam626](https://github.com/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](LICENSE) .