.. image:: https://github.com/dbrgn/coverage-badge/workflows/CI/badge.svg :alt: Build status :target: https://github.com/dbrgn/coverage-badge/actions?query=branch%3Amain
A small script to generate coverage badges using Coverage.py. Example of a generated badge:
.. image:: https://cdn.rawgit.com/dbrgn/coverage-badge/main/example.svg :alt: Example coverage badge
The badge template has been taken from shields.io_, therefore it should look mostly good. (The spec is a bit stricter on the margins, but I can't easily do text width calculations in Python so the margins might not always be 4px.)
➡️ Note: If you need a script with a few more features (e.g. test badges, flake8 reports, etc), check out genbadge_.
pip install coverage-badge
First, run Coverage.py to generate the necessary coverage data. Then you can either return the badge SVG to stdout::
...or write it to a file::
coverage-badge -o coverage.svg
It's important that you run
coverage-badge from the directory where the
.coverage data file is located.
Different colors for cover ranges:
.. image:: https://cdn.rawgit.com/samael500/coverage-badge/main/media/15.svg :alt: 15%
.. image:: https://cdn.rawgit.com/samael500/coverage-badge/main/media/45.svg :alt: 45%
.. image:: https://cdn.rawgit.com/samael500/coverage-badge/main/media/65.svg :alt: 65%
.. image:: https://cdn.rawgit.com/samael500/coverage-badge/main/media/80.svg :alt: 80%
.. image:: https://cdn.rawgit.com/samael500/coverage-badge/main/media/93.svg :alt: 93%
.. image:: https://cdn.rawgit.com/samael500/coverage-badge/main/media/97.svg :alt: 97%
The full usage text::
usage: __main__.py [-h] [-o FILEPATH] [-p] [-f] [-q] [-v] Generate coverage badges for Coverage.py. optional arguments: -h, --help show this help message and exit -o FILEPATH Save the file to the specified path. -p Plain color mode. Standard green badge. -f Force overwrite image, use with -o key. -q Don't output any non-error messages. -v Show version.
MIT License, see