intellisense / python-blacken

A customisable GitHub action to check the style of Python code with black.

python-blacken

A customisable GitHub action to check the style of Python code with black.

Inputs

You can use inputs to alter how black will check your code.

Path (optional)

This tells black where to look for files to check.

Default: ., i.e. looks for files in the whole repository.

Line-length (optional)

This tells black how long each line of Python code can be.

Sanity-check (optional)

If --fast given, skip temporary sanity checks. Options [fast|safe]. Default fast.

Only-check (optional)

Only check the files instead of modify them. Options [yes|no]. Default yes.

Example usage

Include this in your .github/workflows/main.yaml:

uses: piotrpawlaczek/python-blacken@release/stable

or, if you want to override any of the defaults,

uses: piotrpawlaczek/python-blacken@release/stable


with:
  line-length: '88'
  path: '.'
  sanity-check: 'safe'
  only-check: 'no'