Skip to main content

Command line interface for interacting with the Terra Scientific Pipelines Service, or Teaspoons.

Project description

Terralab CLI

Quality Gate Status

Overview

The Terralab CLI provides a command-line interface with which to interact with the Terra Scientific Pipelines Service, or Teaspoons.

Currently, Terralab supports running Genotype Imputation (for public release in early 2025).

Note that in order to use Terralab and Teaspoons, you must have a Terra account.

User instructions coming soon.

Installation

You can install the Terralab CLI from PyPi using your favorite package management tool.

For example, run

pip install terralab-cli

Using the CLI

Once installed, to run the CLI, run the following command:

terralab COMMAND [ARGS]

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

terralab pipelines list

(Internal) WIP documentation for the CLI.

Python CLI structure

The CLI code is structured as follows:

terra-scientific-pipelines-service-cli
├── terralab
│   └── commands
│   │   └── __init__.py
│   │   └── auth_commands.py
│   │   └── pipelines_commands.py
│   └── logic
│   │   └── __init__.py
│   │   └── auth_logic.py
│   │   └── pipelines_logic.py
│   └── __init__.py
│   └── auth_helper.py
│   └── cli.py
│   └── client.py
│   └── config.py
│   └── teaspoons
├── tests
│   └── commands
│   │   └── test_auth_commands.py
│   │   └── test_pipelines_commands.py
│   └── logic
│   │   └── test_auth_logic.py
│   │   └── test_pipelines_logic.py
│   └── __init__.py
│   └── auth_helper.py
│   └── cli.py
│   └── client.py
│   └── config.py
│   └── terralab
├── .gitignore
├── .terralab-cli-config
├── poetry.lock
├── pyproject.toml
├── README.md

In the terralab directory, we have the following files and subdirectories:

  • auth_helper.py contains the code for authenticating with the Terra Scientific Pipelines Service (Terra, via b2c).
  • cli.py is the entrypoint for the CLI. It configures logging and assembles the CLI sub-modules that are defined in commands/.
  • client.py contains the code for wrapping API calls to the Terra Scientific Pipelines Service.
  • config.py contains the code for managing the CLI configuration via environment variables.
  • utils.py contains utility functions that are used across the CLI.
  • The commands directory contains the CLI sub-modules. This is effectively the controller layer for the CLI.
  • The logic directory contains the business logic for the CLI, including calling Terra Scientific Pipelines Service APIs via the thin teaspoons_client, which is autogenerated and published by the Terra Scientific Pipelines Service repository.

In the tests directory, we have test files that can be run with pytest.

Development

See CONTRIBUTING.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terralab_cli-0.0.10.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

terralab_cli-0.0.10-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

Details for the file terralab_cli-0.0.10.tar.gz.

File metadata

  • Download URL: terralab_cli-0.0.10.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for terralab_cli-0.0.10.tar.gz
Algorithm Hash digest
SHA256 5891f212e01a968f1fcaa056d260d3fbd294b9912df96faf47b1432caadd47ad
MD5 7f537f3369ee5f548b2803981e9e42c1
BLAKE2b-256 eff075d7ef2ae8117693d1a6bfca38ff2b42085d0bea5dcf8a1dba76fa9056dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for terralab_cli-0.0.10.tar.gz:

Publisher: bump-build-publish-cli.yml on DataBiosphere/terra-scientific-pipelines-service-cli

Attestations:

File details

Details for the file terralab_cli-0.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for terralab_cli-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 bdef896d4452b7c2d251a15ff93b5af254c77a2736ba24acedffc71e0bb6a519
MD5 74bff1899cd8886afb6763caadcc7498
BLAKE2b-256 b22e28cdd5e53023bb491fcf91d21917fcf1c4e755ebb9796fa4c1c3676371a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for terralab_cli-0.0.10-py3-none-any.whl:

Publisher: bump-build-publish-cli.yml on DataBiosphere/terra-scientific-pipelines-service-cli

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page