Skip to content

pyrig-codecov Documentation

CI CD

CoverageTester ProjectTester

DependencyAuditor DependencyChecker MarkdownLinter PythonLinter SecurityChecker SpellChecker TypeChecker VersionControlHookManager

PackageManager Pyrigger RemoteVersionController VersionController

DocsBuilder PackageIndex ProgrammingLanguage License

A pyrig plugin that integrates codecov.

Overview

Drop-in pyrig plugin that wires Codecov into your project:

  • Enforces 100% coverage as the pass threshold.
  • Generates coverage.xml alongside your normal test run.
  • Adds a Codecov upload step to the CI health-check workflow.
  • Adds coverage.xml to your version control ignore list.
  • Adds a Codecov badge to your README.

No configuration required — installing the package as a development dependency is the whole setup. Then regenerate your pyrig configs as usual. The plugin's overrides are picked up automatically.

Installation

uv add pyrig-codecov --dev
uv run pyrig sync

Setup

A one-time setup on the repository side is required:

  1. Codecov Account - Get an account on codecov.io.
  2. Upload Token - Get an upload token from Codecov
  3. Add token to repository secrets - Add the token to your repository secrets on GitHub as CODECOV_TOKEN

After that, every CI health check run uploads its coverage report to Codecov.

How it works

The plugin subclasses pyrig base classes:

  • CoverageTester — overrides the coverage threshold, report format, badge URLs, and the auth token key.
  • HealthCheckWorkflowConfigFile — appends a codecov/codecov-action@main step to the matrix health-check job

API Reference

For class- and method-level details, see the API Reference, generated automatically from the source.