Skip to main content

Scripting interface to the Tapis platform. Documentation at https://tapis-cli.rtfd.io/

Project description

build status Documentation Publication

Tapis CLI is a human-friendly, scriptable command line interface, implemented in Python, that helps scientists and engineers build and manage scalable computational and data science workflow projects using the Tapis platform. It is a replacement for a pure-Bash CLI environment known as agave-cli that we hope brings you new features, better reliability, and dramatically enhanced productivity.

Tapis CLI provides a unified interface to multiple web service APIs, allowing them to be easily orchestrated and composed into higher-order constructs combining HPC, data management, cloud computing, and other aspects of computing.

Documentation: https://tapis-cli.readthedocs.io/en/latest/

Installation

$ git clone https://github.com/TACC-Cloud/tapis-cli-ng.git
$ cd tapis-cli-ng
$ pip install --upgrade --user .

Container Image

As an alternative to local installation, the CLI is available as a public Docker image tacc/tapis-cli-ng:latest on DockerHub:

docker run --rm -it -v ${PWD}:/work -v ${HOME}/.agave:/root/.agave \
    tacc/tapis-cli-ng:latest bash

Initialize a Session

You must set up a Tapis session on each host where you will use Tapis CLI. This is a scripted process implemented by tapis auth init. Here’s an example:

$ tapis auth init

Use of Tapis requires acceptance of the TACC Acceptable Use Policy,
which can be found at https://portal.tacc.utexas.edu/tacc-usage-policy

Do you agree to abide by the AUP? (type 'y' or 'n' then Return) y

To improve our ability to support Tapis and the Tapis CLI, we would like to
collect your IP addrress, operating system and Python version. No personally-
identifiable information will be collected. This data will only be shared in
aggregate form with funders and Tapis platform stakeholders.

Do you consent to this reporting? [Y/n]: y

Available Tenants
=================
3dem        agave.prod      araport.org     bridge  designsafe
iplantc.org irec    portals sd2e    sgci
tacc.prod   vdjserver.org

Enter a tenant name: tacc.prod
Username: tacotron
Password for tacotron:
+--------------+---------------------------------+
| Field        | Value                           |
+--------------+---------------------------------+
| tenant_id    | tacc.prod                       |
| username     | tacotron                        |
| client_name  | _cli-tacc.prod-tacotron-macbook |
| api_key      | uAShaDfy0vF7hgFcAqx7oeAtO6oa    |
| access_token | a31c66cfaa45451c95df6fd473ffd4b |
| expires_at   | Thu Sep 19 14:08:37 2019        |
+--------------+---------------------------------+

Get Started

The CLI features extensive contextual help. Get a listing of supported commands and global options via --help.

$ tapis --help

Find available commands:

$ tapis apps --help
Command "apps" matches:
apps create
apps disable
apps enable
apps history
apps list
apps pems grant
...

Get help for a specific command:

There is a --help flag for each command.

$ tapis help apps list
$ # or
$ tapis apps list --help

Issue Tracker

Major functional objectives are bundled into Milestones with due dates in the future. This provides a way to organize the work and have a public road map for functionality.

All work should proceed through at least one or more reported Issues.

Project details


Download files

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

Files for tapis-cli, version 1.0.0.0a6
Filename, size File type Python version Upload date Hashes
Filename, size tapis_cli-1.0.0.0a6-py2.py3-none-any.whl (266.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size tapis_cli-1.0.0.0a6.tar.gz (234.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page