# 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 <metric>
```
where `<metric>` 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 <metric> <value>
```
Raw data
{
"_id": null,
"home_page": "https://coverage.space/client/",
"name": "coveragespace",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "coverage, testing, command-line",
"author": "Jace Browning",
"author_email": "jacebrowning@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3b/74/fa7c8acc6d9cd18e5489f1abd9994d1202d643e88722f52c9ba4ebc5ccd3/coveragespace-6.1.tar.gz",
"platform": null,
"description": "# Overview\n\nThe official command-line client for [The Coverage Space](http://coverage.space).\n\n[![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)\n[![Coverage Status](https://img.shields.io/coveralls/jacebrowning/coverage-space-cli/main.svg)](https://coveralls.io/r/jacebrowning/coverage-space-cli)\n[![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)\n[![PyPI Version](https://img.shields.io/pypi/v/coveragespace.svg)](https://pypi.org/project/coveragespace)\n[![PyPI License](https://img.shields.io/pypi/l/coveragespace.svg)](https://pypi.org/project/coveragespace)\n\n# Setup\n\n## Requirements\n\n- Python 3.7+\n\n## Installation\n\nInstall this tool globally with [pipx](https://pipxproject.github.io/pipx/) (or pip):\n\n```text\n$ pipx install coveragespace\n```\nor add it to your [Poetry](https://python-poetry.org/docs/) project:\n\n```text\n$ poetry add coveragespace\n```\n\n# Usage\n\nTo update the value for a test coverage metric:\n\n```text\n$ coveragespace update <metric>\n```\n\nwhere `<metric>` is one of:\n\n- **unit**\n- **integration**\n- **overall**\n\nFor example, after running unit tests with code coverage enabled:\n\n```text\n$ coveragespace update unit\n```\n\nwhich 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:\n\n```text\n$ coveragespace update <metric> <value>\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A place to track your code coverage metrics.",
"version": "6.1",
"project_urls": {
"Documentation": "https://cli.coverage.space",
"Homepage": "https://coverage.space/client/",
"Repository": "https://github.com/jacebrowning/coverage-space-cli"
},
"split_keywords": [
"coverage",
" testing",
" command-line"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "598a16f9cee87d520a28fb474233c99360014c65240c750e3dd29bd2aa37fdf0",
"md5": "e44cfc0efd0bbb31e97eb05e0c2895f1",
"sha256": "ca6ccd5eb32eb6ce5fe78de6c052353b9fbb378a886fde0838480defe33406a8"
},
"downloads": -1,
"filename": "coveragespace-6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e44cfc0efd0bbb31e97eb05e0c2895f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 12495,
"upload_time": "2024-04-05T00:34:40",
"upload_time_iso_8601": "2024-04-05T00:34:40.798190Z",
"url": "https://files.pythonhosted.org/packages/59/8a/16f9cee87d520a28fb474233c99360014c65240c750e3dd29bd2aa37fdf0/coveragespace-6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b74fa7c8acc6d9cd18e5489f1abd9994d1202d643e88722f52c9ba4ebc5ccd3",
"md5": "d5eab25435acfd3af1a7bbb28663e575",
"sha256": "049c0b7b629ad43d72692f0f99b9f8a97936ad596f7f27c1af61323fba90ebef"
},
"downloads": -1,
"filename": "coveragespace-6.1.tar.gz",
"has_sig": false,
"md5_digest": "d5eab25435acfd3af1a7bbb28663e575",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 9276,
"upload_time": "2024-04-05T00:34:42",
"upload_time_iso_8601": "2024-04-05T00:34:42.564945Z",
"url": "https://files.pythonhosted.org/packages/3b/74/fa7c8acc6d9cd18e5489f1abd9994d1202d643e88722f52c9ba4ebc5ccd3/coveragespace-6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 00:34:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jacebrowning",
"github_project": "coverage-space-cli",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "coveragespace"
}