https://github.com/jacebrowning/coverage-space-cli

Command-line client for The Coverage Space.
https://github.com/jacebrowning/coverage-space-cli

coverage metrics testing

Last synced: 5 months ago
JSON representation

Command-line client for The Coverage Space.

• Host: GitHub
• URL: https://github.com/jacebrowning/coverage-space-cli
• Owner: jacebrowning
• License: mit
• Created: 2016-02-06T16:21:09.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2026-01-17T20:48:29.000Z (5 months ago)
• Last Synced: 2026-01-18T06:58:46.336Z (5 months ago)
• Topics: coverage, metrics, testing
• Language: Python
• Homepage: https://cli.coverage.space
• Size: 605 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Overview

The official command-line client for [The Coverage Space](http://coverage.space).

[![Build Status](https://img.shields.io/github/actions/workflow/status/jacebrowning/coverage-space-cli/main.yml?branch=main&label=build)](https://github.com/jacebrowning/coverage-space-cli/actions)

[![Coverage Status](https://img.shields.io/coveralls/jacebrowning/coverage-space-cli/main.svg)](https://coveralls.io/r/jacebrowning/coverage-space-cli)

[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/jacebrowning/coverage-space-cli.svg)](https://scrutinizer-ci.com/g/jacebrowning/coverage-space-cli/?branch=main)

[![PyPI Version](https://img.shields.io/pypi/v/coveragespace.svg)](https://pypi.org/project/coveragespace)

[![PyPI License](https://img.shields.io/pypi/l/coveragespace.svg)](https://pypi.org/project/coveragespace)

# Setup

## Requirements

- Python 3.7+

## Installation

Install this tool globally with [pipx](https://pipxproject.github.io/pipx/) (or pip):

```text

$ pipx install coveragespace

```

or add it to your [Poetry](https://python-poetry.org/docs/) project:

```text

$ poetry add coveragespace

```

# Usage

To update the value for a test coverage metric:

```text

$ coveragespace update 

```

where `` is one of:

- **unit**

- **integration**

- **overall**

For example, after running unit tests with code coverage enabled:

```text

$ coveragespace update unit

```

which will attempt to extract the current coverage data from your project directory and compare that with the last known value. The coverage value can also be manually specified:

```text

$ coveragespace update  

```