Metadata-Version: 2.4
Name: cpp-coverage
Version: 0.1.0
Summary: C++ coverage reports, changed-code PR gating with coverage provenance checks, and a static coverage website.
Author-email: "Andrew J. Sender" <AndrewJ.Sender@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/AndrewJSender/coverage-analytics
Project-URL: Documentation, https://github.com/AndrewJSender/coverage-analytics/tree/main/docs
Project-URL: Repository, https://github.com/AndrewJSender/coverage-analytics
Project-URL: Issues, https://github.com/AndrewJSender/coverage-analytics/issues
Keywords: coverage,code-coverage,c++,cpp,llvm,diff-coverage,changed-code-coverage
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# C++ Code Coverage

A small coverage tooling project for generating coverage reports and a static website view from test outputs.

## Installation

```zsh
pip install cpp-coverage
```

## Quick start

```zsh
# Generate coverage reports and website data from an instrumented test binary.
coverage-analytics profile --test-binary build/Debug/coverage_example \
  --output-directory build/coverage_example_output

# Analyze coverage of lines changed since main.
coverage-analytics diff main --coverage build/coverage_example_output

# Enforce the changed-coverage gate in CI (GitHub Actions).
coverage-analytics diff "$BASE_SHA...HEAD" --coverage build/coverage_example_output \
  --format json > diff-coverage.json
coverage-analytics gate diff-coverage.json
```

## Documentation

### Getting started

- [Build and run the example](docs/getting-started.md)

### Guides

- [Changed-code coverage](docs/changed-code-coverage.md)
- [Coverage website](docs/coverage-website.md)

### Reference

- [Coverage tools and report formats](docs/reference.md)

## License

Copyright (c) 2026 Andrew J. Sender (AndrewJ.Sender@gmail.com)

This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
