Metadata-Version: 2.1
Name: coveragepy-lcov
Version: 0.1.1
Summary: A simple .coverage to LCOV converter
Home-page: https://github.com/chaychoong/coveragepy-lcov
Keywords: coverage
Author: Chay Choong
Author-email: chaychoong@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: coverage (>=5.5,<6.0)
Project-URL: Repository, https://github.com/chaychoong/coveragepy-lcov
Description-Content-Type: text/markdown

# coveragepy-lcov

This package provides a simple CLI for converting .coverage files to the LCOV format.

# Usage

```bash
pip install coveragepy-lcov

# If the .coverage file is in your current working directory
coveragepy-lcov

# Point to a different .coverage file path
coveragepy-lcov --data_file_path example/.coverage

# Write the output to a different file path
coveragepy-lcov --output_file_path build/lcov.info

# Use relative paths in the LCOV output
coveragepy-lcov --relative_path
```

# Configuration

```text
Usage: coveragepy-lcov [OPTIONS]

Options:
  --data_file_path TEXT    Path to .coverage file
  --output_file_path TEXT  lcov.info output file path
  --config_file TEXT       Path to .coveragerc file
  --relative_path          Use relative path in LCOV output
  --preview                Preview LCOV output
  --help                   Show this message and exit.
```

