black-codeclimate 1.0.1

Convert black --diff output to a Code Climate report

black-codeclimate

Convert the output of black --diff to a report conforming to the Code Climate spec. It is aimed at GitLab CI, for which it can generate a Code Quality report.

Usage

Pipe the output of black --diff into black-codeclimate:

black --diff src/ | black-codeclimate > black_report.json

Or specify a file to use as input:

black-codeclimate black.diff > black_report.json

You can also change the severity, description and check_name of the issues in the resulting report by specifying command line flags:

black-codeclimate --severity blocker --description "Would reformat" --check-name "black" black.diff > black_report.json

To include in GitLab CI:

lint:black:
  stage: lint
  script:
    - # Install black and black-codeclimate...
    - black --diff src/ | black-codeclimate > black_report.json
  artifacts:
    reports:
      codequality: black_report.json
    when: always