Metadata-Version: 2.4
Name: gencove
Version: 4.2.1
Summary: Gencove API and CLI tool
Author-email: Gencove Engineering Team <engineering@gencove.com>
License: Apache-2.0
Project-URL: Homepage, https://docs.gencove.com
Project-URL: Documentation, https://docs.gencove.com/base/getting-started/
Project-URL: Repository, https://gitlab.com/gencove/cli
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python-dateutil>=2.2.0
Requires-Dist: six>=1.5
Requires-Dist: Click<=8.1.8,>=7.0
Requires-Dist: requests>=2.19.1
Requires-Dist: boto3>=1.17.97
Requires-Dist: progressbar2==3.55.0
Requires-Dist: backoff<=2.2.1
Requires-Dist: pydantic==2.10.3
Requires-Dist: click-default-group>=1.2.4
Provides-Extra: dev
Requires-Dist: tox==3.28.0; extra == "dev"
Requires-Dist: pre-commit==2.17.0; extra == "dev"
Requires-Dist: pyinstaller==6.11.1; extra == "dev"
Requires-Dist: urllib3<=2; extra == "dev"
Requires-Dist: black==22.6.0; extra == "dev"
Requires-Dist: flake8==5.0.4; extra == "dev"
Requires-Dist: flake8-import-order==0.18.1; extra == "dev"
Requires-Dist: flake8-typing-imports==1.12.0; extra == "dev"
Requires-Dist: pep8-naming==0.12.1; extra == "dev"
Requires-Dist: pyflakes==2.5.0; extra == "dev"
Requires-Dist: pylint==2.13.9; extra == "dev"
Requires-Dist: bandit==1.7.1; extra == "dev"
Requires-Dist: importlib-metadata==4.13.0; extra == "dev"
Requires-Dist: pbr==6.1.0; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest==7.0.1; extra == "test"
Requires-Dist: pytest-mock==3.6.1; extra == "test"
Requires-Dist: pytest-cov==3.0.0; extra == "test"
Requires-Dist: pytest-xdist==2.5.0; extra == "test"
Requires-Dist: pytest-recording==0.12.1; extra == "test"
Requires-Dist: vcrpy==4.1.1; extra == "test"
Requires-Dist: faker==14.0.0; extra == "test"
Dynamic: license-file

# The Gencove CLI

[![PyPI Latest Release](https://img.shields.io/pypi/v/gencove.svg)](https://pypi.org/project/gencove/)
[![License](https://img.shields.io/pypi/l/gencove.svg)](https://github.com/gncv/gencove-cli/blob/master/LICENSE)

## What is Gencove?

Gencove is a high-throughput, cost-effective platform for genome sequencing and analysis, enabling a wide array of genomics applications across industries. Furthermore, it is the only enterprise analytics platform for low-pass whole genome sequencing (lpWGS).


The Gencove command-line interface (CLI) can be used to easily access the Gencove platform.

## Main Features

It is most often used for:
* [Uploading FASTQ files](https://docs.gencove.com/base/analysis/fastq-files/uploading-using-the-cli/) for analysis
* [Downloading analysis results](https://docs.gencove.com/base/analysis/samples/downloading-deliverables/) which include the following:
  * Sequence (`.fastq.gz`)
  * Alignment (`.bam`, `.bai`)
  * Imputation (`.vcf.gz`, `.vcf.gz.tbi`, `.vcf.gz.csi`)
* [Assigning metadata](https://docs.gencove.com/base/analysis/samples/sample-metadata-and-files/#assigning-sample-metadata) to Gencove samples

Before filing a bug report, please refer to the following [link](https://docs.gencove.com/general/support/#filing-a-bug-report-for-the-cli). Bugs should be reported [here](https://resources.gencove.com/hc/en-us/requests/new).

## Installation
```
# install via PyPI
pip install gencove

# updating to latest version
pip install -U gencove
```

## Documentation

Online documentation (with examples) is available at [docs.gencove.com](https://docs.gencove.com/base/getting-started/)

API reference for publicly available endpoints: [API Reference](https://api.gencove.com/api/v2/docs/)

Comprehensive CLI Documentation available: [CLI Reference](https://docs.gencove.com/base/cli-reference/)
