Metadata-Version: 2.4
Name: terralab-cli
Version: 1.0.9
Summary: Command line interface for interacting with the Terra Scientific Pipelines Service, or Teaspoons.
License-File: LICENSE
Author: Terra Scientific Services
Author-email: teaspoons-developers@broadinstitute.org
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: PyJWT (>=2.9.0,<3.0.0)
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: colorlog (>=6.9.0,<7.0.0)
Requires-Dist: cryptography (>=44.0.1,<45.0.0)
Requires-Dist: oauth2-cli-auth (>=1.5.0,<2.0.0)
Requires-Dist: poetry (==1.8.5)
Requires-Dist: prompt-toolkit (>=3.0.51,<4.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: tabulate (>=0.9.0,<0.10.0)
Requires-Dist: terra-scientific-pipelines-service-api-client (==1.2.1)
Requires-Dist: tqdm (>=4.67.0,<5.0.0)
Requires-Dist: tzlocal (>=5.2,<6.0)
Description-Content-Type: text/markdown

# Terralab CLI

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DataBiosphere_terra-scientific-pipelines-service-cli&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=DataBiosphere_terra-scientific-pipelines-service-cli)

## Overview
The terralab CLI provides a command-line interface with which to interact with the [Broad DSP Scientific Pipelines Service](https://github.com/DataBiosphere/terra-scientific-pipelines-service/blob/main/README.md).

Currently, terralab supports running [Array Imputation](https://allofus-anvil-imputation.terra.bio/). For more information about Array Imputation, see our [documentation](https://broadscientificservices.zendesk.com/hc/en-us/articles/39901941351323).

Find instructions on using this CLI [here](https://broadscientificservices.zendesk.com/hc/en-us/articles/39901313672859).

Note that in order to use terralab and the Scientific Pipelines Service, you must have a [Terra](https://services.terra.bio/) account.

## Prerequisites
Your system must run Python 3.12+.

## Installation
You can install the terralab CLI [from PyPi](https://pypi.org/project/terralab-cli/) using your favorite package management tool. 

For example, run
```bash
pip install terralab-cli
```

## Using the CLI
Once installed, to run the CLI, run the following command:
```bash
terralab COMMAND [ARGS]
```

For example, to list the pipelines you can run using Terralab, run the following command:
```bash
terralab pipelines list
```

## Development
See [CONTRIBUTING.md](CONTRIBUTING.md).

## Changelog
See [CHANGELOG.md](https://github.com/DataBiosphere/terra-scientific-pipelines-service-cli/blob/main/CHANGELOG.md)

