Coverage Badge

1.1.2 · maintenance · verified Mon Apr 13

coverage-badge is a Python utility that generates SVG coverage badges based on data produced by the `Coverage.py` tool. While it currently stands at version 1.1.2, the project is in maintenance mode, meaning it will receive only occasional updates and fixes, but no new features. Users seeking more advanced features or active development are encouraged to explore alternatives like `genbadge`.

Warnings

deprecated The `coverage-badge` project is in maintenance mode and will not receive new features. It is recommended to use `genbadge` for more features and active development.
Fix: Consider migrating to `genbadge` for new projects or if advanced features are required.
gotcha The `coverage-badge` command must be run from the directory where the `.coverage` data file (generated by `Coverage.py`) is located.
Fix: Navigate to the correct directory using `cd` before running `coverage-badge`, or specify the path to the `.coverage` file if the tool supported it (which it doesn't currently, based on documentation).
gotcha `coverage-badge` requires `Coverage.py` to have been run previously to generate a `.coverage` data file. Without this file, the badge cannot be generated.
Fix: Always run `coverage run ...` (e.g., `coverage run -m pytest`) before attempting to generate the badge with `coverage-badge`.

Install

pip install coverage-badge Install latest version

Quickstart

To generate a coverage badge, first run `Coverage.py` (e.g., via `pytest --cov`) to produce coverage data. Then, execute `coverage-badge` in the same directory as the `.coverage` data file to generate the SVG image.

# 1. Run Coverage.py to generate coverage data
# (Example with pytest, ensure pytest-cov is installed if using pytest)
# pip install coverage pytest pytest-cov
coverage run -m pytest

# 2. Generate the coverage badge SVG file
#    Ensure you run this command from the directory where the .coverage data file is located.
coverage-badge -o coverage.svg

# The coverage.svg file is now generated and can be embedded in your README.md
# Example markdown: ![Coverage](coverage.svg)

view raw JSON →