Metadata-Version: 2.1
Name: coveragepy-lcov
Version: 0.1.2
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.6.3,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=7.1.2)
Requires-Dist: coverage (>=5.5)
Project-URL: Repository, https://github.com/chaychoong/coveragepy-lcov
Description-Content-Type: text/markdown

# coveragepy-lcov

`coveragepy-lcov` is a simple CLI for converting `.coverage` files generated by [Coverage.py](https://github.com/nedbat/coveragepy) to the `LCOV` format.

## Credits

This tools is based on code from [Coverage.py](https://github.com/nedbat/coveragepy/blob/master/coverage/report.py).

## Installation

Using pip:

```bash
pip install coveragepy-lcov
```

## Usage

```bash
# 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
```

## Options

```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.
```

## Further reading

- [LCOV format](http://ltp.sourceforge.net/coverage/lcov/geninfo.1.php)
- https://github.com/nedbat/coveragepy/issues/587

