Metadata-Version: 2.1
Name: coveragespace
Version: 3.2b1
Summary: A place to track your code coverage metrics.
Home-page: https://coverage.space/client/
License: MIT
Keywords: coverage,testing,command-line
Author: Jace Browning
Author-email: jacebrowning@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Dist: colorama (>=0.3,<0.4)
Requires-Dist: coverage
Requires-Dist: docopt (>=0.6,<0.7)
Requires-Dist: minilog (>=1.6,<2.0)
Requires-Dist: requests (>=2.0,<3.0)
Project-URL: Documentation, https://cli.coverage.space
Project-URL: Repository, https://github.com/jacebrowning/coverage-space-cli
Description-Content-Type: text/markdown

# Overview

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

[![Unix Build Status](https://img.shields.io/travis/jacebrowning/coverage-space-cli/main.svg?label=unix)](https://travis-ci.org/jacebrowning/coverage-space-cli)
[![Windows Build Status](https://img.shields.io/appveyor/ci/jacebrowning/coverage-space-cli/main.svg?label=window)](https://ci.appveyor.com/project/jacebrowning/coverage-space-cli)
[![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.5+

## Installation

Install this library directly into an activated virtual environment:

```text
$ pip install coveragespace
```

or add it to your [Poetry](https://poetry.eustace.io/) project:

```text
$ poetry add coveragespace
```

# Usage

To update the value for a test coverage metric:

```sh
$ coveragespace <owner/repo> <metric>
```

For example, after testing with code coverage enabled:

```sh
$ coveragespace owner/repo unit
```

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

```sh
$ coveragespace <owner/repo> <metric> <value>
```

