Skip to content

Home

CI CD ProjectTester

ByteOrderMarkerFormatter CaseConflictChecker DependencyChecker EndOfFileFormatter EndOfLineFormatter JSONFormatter JSONLinter LargeFileChecker MarkdownLinter MergeConflictChecker ModuleTestNamingChecker PythonLinter SecretsChecker SecurityChecker ShellFormatter ShellLinter SpellChecker TOMLLinter TrailingWhitespaceFormatter TypeChecker YAMLLinter

PackageManager Pyrigger RemoteVersionController VersionControlHookManager VersionController

DocsBuilder PackageIndex ProgrammingLanguage 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:

  • ProjectTester — overrides the coverage threshold and badge URLs, and adds a report format/file and auth token key for the Codecov upload step.
  • 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.