mypy-gitlab-code-quality

Simple script to generate gitlab code quality report
from output of mypy.

Example gitlab codequality widget from gitlab documentation:

Usage

$ mypy program.py --output=json | mypy-gitlab-code-quality

This command send to STDOUT generated json that can be used as Code Quality report artifact.

Also, this script supports plain text output parsing for backward compatability but json is recommended.

$ mypy program.py | mypy-gitlab-code-quality

Example .gitlab-ci.yml

image: python:alpine
codequality:
  script:
    - pip install mypy mypy-gitlab-code-quality
    - mypy program.py --output=json > mypy-out.json || true  # "|| true" is used for preventing job fail when mypy find errors
    - mypy-gitlab-code-quality < mypy-out.json > codequality.json
  artifacts:
    when: always
    reports:
      codequality: codequality.json

Note: if you want to use this example you should replace program.py with yours module names.

Contributing

Please run linters and tests before creating pull request

pip install requirements/dev.txt
mypy .
ruff check
ruff format
python -m unittest

Suggestions and pull requests are always welcome :)