Skip to content

ProjectCoverageTester (pytest-cov)

Constructs Codecov dashboard URLs and coverage badge Markdown for your project.

Unlike other Tool wrappers that wrap external CLI tools, ProjectCoverageTester generates Codecov URLs dynamically from your git remote configuration. It's used internally by pyrig to populate coverage badge links in README files.

Subclassing Example

# myapp/rig/tools/project_coverage_tester.py
from pyrig.rig.tools.project_coverage_tester import (
    ProjectCoverageTester as BasePCT,
)

class ProjectCoverageTester(BasePCT):
    def remote_coverage_url(self) -> str:
        # Use Coveralls instead of Codecov
        owner, repo = VersionController.I.repo_owner_and_name(
            check_repo_url=False, url_encode=True
        )
        return f"https://coveralls.io/github/{owner}/{repo}"