https://github.com/pythonic-emacs/blacken

Python Black for Emacs
https://github.com/pythonic-emacs/blacken

Last synced: about 2 hours ago
JSON representation

Python Black for Emacs

• Host: GitHub
• URL: https://github.com/pythonic-emacs/blacken
• Owner: pythonic-emacs
• License: gpl-3.0
• Created: 2018-03-26T11:32:45.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-21T10:59:10.000Z (9 months ago)
• Last Synced: 2024-08-02T13:21:19.142Z (9 months ago)
• Language: Emacs Lisp
• Size: 42 KB
• Stars: 192
• Watchers: 9
• Forks: 33
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![MELPA](https://melpa.org/packages/blacken-badge.svg)](https://melpa.org/#/blacken)

[![MELPA Stable](https://stable.melpa.org/packages/blacken-badge.svg)](https://stable.melpa.org/#/blacken)

[![CI](https://github.com/pythonic-emacs/blacken/actions/workflows/test.yml/badge.svg)](https://github.com/pythonic-emacs/blacken/actions/workflows/test.yml)

# Blacken

Use the python `black` package to reformat your python buffers.

## usage

The whole buffer can be reformatted with `blacken-buffer`. If you want

to format every time you save, enable `blacken-mode` in relevant

python buffers. Note that if `blacken-only-if-project-is-blackened` is

non-nil, then blacken will only run if your `pyproject.toml` contains

the `[tool.black]` setting. This setting is off by default.

## customization

The following options change the behavior of black when reformatting buffers.

- `blacken-allow-py36` Allow using Python 3.6-only syntax on all input files.

- `blacken-skip-string-normalization` Don't normalize string quotes or prefixes.

- `blacken-fast-unsafe` Skips temporary sanity checks.

- `blacken-line-length` Max line length enforced by blacken.

## license

`blacken.el` is free software; you can redistribute it and/or modify it

under the terms of the GNU General Public License as published by the

Free Software Foundation; either version 3, or (at your option) any later

version.

SPDX-License-Identifier: GPL-3.0-or-later