Skip to content

Home

CI CD ProjectTester SecurityPracticesChecker Best Practices Baseline

ByteOrderMarkerFormatter CICDLinter CICDSecurityChecker CaseConflictChecker CodeAnalyzer DeadCodeChecker DependencyChecker EndOfFileFormatter EndOfLineFormatter FuzzTester JSONFormatter JSONLinter LargeFileChecker MarkdownLinter MergeConflictChecker ModuleTestNamingChecker PythonLinter PythonOrderLinter SecretsChecker SecurityChecker ShellFormatter ShellLinter SpellChecker TOMLLinter TrailingWhitespaceFormatter TypeChecker XMLLinter YAMLLinter

PackageManager Pyrigger RemoteVersionController VersionControlHookManager 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 an isolated Codecov upload job 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. Connect your repository - Enable the repository in Codecov and grant the Codecov GitHub App access as needed.

How it works

The plugin subclasses pyrig base classes:

  • ProjectTester — overrides the coverage threshold and badge URLs, and adds a report format/file for the Codecov upload step.
  • HealthCheckWorkflowConfigFile — stores each matrix report with commit-pinned actions/upload-artifact, using a unique OS/Python artifact name. A separate job downloads this run's reports with commit-pinned actions/download-artifact, keeping them in separate subdirectories, then publishes them with commit-pinned codecov/codecov-action.

API Reference

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