Generate coverage badges for Coverage.py.
Project description
⚠️ coverage-badge is in maintenance mode. I might still do occasional updates and fixes from time to time, but there will be no added features. Most people using coverage-badge might want to use genbadge instead, which has more features (e.g. test badges, flake8 reports, etc).
A small script to generate coverage badges using Coverage.py.
Example of a generated 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.)
Installation
Run:
pip install coverage-badge
Usage
First, run Coverage.py to generate the necessary coverage data. Then you can either return the badge SVG to stdout:
$ coverage-badge
…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:
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.
License
MIT License, see LICENSE.txt file..
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for coverage_badge-1.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8413ce51c91043a1692b943616b450868cbeeb0ea6a0c54a32f8318c9c96ff7 |
|
MD5 | 0203217ed9ea72b1d0c9b45d7c982dd2 |
|
BLAKE2b-256 | 903d5642a1a06191b2e1e0f87a2e824e6d3eb7c32c589a68ed4d1dcbd3324d63 |