Skip to content

Commit 6c93988

Browse files
committed
chore: README
1 parent 2fb7393 commit 6c93988

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
99
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
1010

11-
Standalone tool to convert Mypy output to Code Climate format. It does not require the Code Climate CLI and is dependency-free: great for CI/CD.
11+
Standalone tool to convert Mypy output to Code Climate format. It does not require the Code Climate CLI and is dependency-free: great for CI/CD. Keeps sane exit codes for your CI.
12+
Additionally, can be used as a Python library.
1213

1314
## Why Code Climate
1415

@@ -38,6 +39,12 @@ mypy <command_args> | mypy-to-codeclimate - mypy-codequality.json
3839
- `1`: Mypy errors, codeclimate report generated
3940
- `2`: Mypy crash (unexpected error) or mypy-to-codeclimate error (invalid arguments, invalid input file, etc.)
4041

42+
43+
### Options
44+
45+
- `--version`: Print version and exit
46+
- `--help`: Print help and exit
47+
4148
## Installation
4249

4350
```bash
@@ -54,12 +61,6 @@ Tested against Mypy 1.6.1. It should work with any version of mypy that outputs
5461

5562
Please open an issue if you find a version of mypy that is not supported.
5663

57-
### Python versions
58-
59-
Tested against Python 3.11. It should work with any actively supported version of Python.
60-
61-
Please open an issue if you have any problem with a specific version of Python.
62-
6364
## Example usage in Gitlab CI
6465

6566
Example of a job that runs mypy and generates a codeclimate report, on a Linux runner.

0 commit comments

Comments
 (0)