tetrascience-cli 2.0.0

Tetrascience CLI

ts-cli

Tetrascience CLI

Table of Contents

Show

• Intro
  • Example
• Install
• Usage
  • Create an artifact
  • Publish an artifact
    • API Configuration
    • IDS Validation
• Extras
  • Protocol Validation
    • Requirements
    • Installation
• Documentation
• Changelog

Intro

ts-cli allows you to interface with the Tetrascience Data Platform from the comfort of your shell

Example

Create and publish a new task script:

ts-cli config save ~/Downloads/ts-cfg.json
ts-cli init task-script
ts-cli publish

Install

pip install tetrascience-cli

Usage

Create an artifact

Create an IDS, Protocol, Task Script, Tetraflow, or Data App artifact

ts-cli init <kind>

To set up the artifact's configuration interactively, use the --interactive or -i flag.

ts-cli init --interactive

Publish an artifact

Including IDS, Protocol, Task Script, or Data App artifacts from their source code

ts-cli publish

The artifact's type, namespace, slug and version are automatically read from its manifest.json file if it exists. To set up the artifact's configuration interactively, use the --interative or -i flag. Examples:

ts-cli publish --interactive

API Configuration

An API configuration is required. This can be the API configuration JSON file (cfg.json) found on the Tetra Data Platform.

{
	"api_url": "https://api.tetrascience.com/v1",
	"auth_token": "your-token",
	"org": "your-org",
	"ignore_ssl": false
}

This configuration can be referred to explicitly in the command line. Example:

ts-cli publish --config cfg.json

Or saved to a specific profile.

ts-cli config save cfg.json --profile dev
ts-cli publish --profile dev

To apply the API configuration to all your projects automatically, save your configuration file globally

ts-cli config save cfg.json --global
ts-cli publish

IDS Validation

When uploading IDS artifact, validation will be performed using ts-ids-validator package. Validation failures for IDS will be printed to the console.

Extras

Protocol Validation

The ts-cli can additionally run protocol v3 validation.

Requirements

• npm at the time of installation to populate dependencies. Neither npm nor Node.js will be used at runtime

Installation

pip install tetrascience-cli[protocol-validation]

Documentation

Click here for --help and a development guide

Changelog

Show

v2.0.0

• --include and --exclude flags take glob patterns instead of relative file paths
• publish command will now read from manifest.json for include and exclude patterns
• Coerce version number string inputs instead of rejecting them when possible
• Data-app templates now use version numbers in more places
• pyproject.toml and package.json files in data-apps now will be updated with the current version number when publishing
• Artifact updating configuration may now look at a package.json file for a version number
• Add JWT token manager to React Data App template
• Add Docs folder to React Data App template
• Performance fixes in publish command

v1.7.1

• Add connector back to the supported types in publish and unpublish
• Various fixes in ts-cli config *
• Add --config option to ts-cli config get to allow reading values out of a config file
• Allow prerelease version strings in interactive configurations

v1.7.0

• Add support for React Data App template
• Support protocol validation when using interactive mode to publish
• Remove limits on publishing data-apps and connectors

v1.6.1

• Add validation for artifact version in interactive mode

v1.6.0

• Add support for new schema artifact type

v1.5.2

• Increase artifact size for connectors and data apps to 2 GB
• Add verbose flag to the publish command
• Add URL normalization for API configuration
• Update base image for Streamlit Data Apps

v1.5.1

• Fix encoding issues when publishing data apps

v1.5.0

• Add support for publishing Streamlit Data Apps from a template

v1.4.2

• update tetraflow template to reflect the latest syntax updates
• adjust files and dirs permissions to ensure lambda user can access all task files
• fix ts-cli init protocol for 3.5 deployments

v1.4.1

• update to the latest protocol compiler version

v1.4.0

• typecheck protocols during publish validation using the protocol virtual machine compiler

v1.3.4

• exclude betas and RCs from latest version check

v1.3.3

• update vulnerable dependencies
• update documentation

v1.3.2

• fix output of monitored build when no args provided (build from the artifact directory)

v1.3.1

• output {namespace, slug, version} when monitored build (via CodeBuild) completes

v1.3.0

• Rename the delete command to unpublish
• Display the number of other artifacts that depend on artifact that is to be unpublished
  • Example: warning: This protocol artifact is used by at least 1 pipeline

v1.2.0

• Allow publishing of connectors artifacts

v1.1.0

• Adjust publish to support Codebuild build_id in response for all artifact types

v1.0.5

• Fix incorrect messages to console when using ts-cli init --interactive

v1.0.4

• Add a delete command
• Remove extra <unset> strings in task script configurations

v1.0.3

• Rename the nodeType field to category in the tetraflow template
• Fix a crash on ts-cli config {save,set}
• Fix broken IDS schemas generated from non-existent manifest.json

v1.0.2

• Adds the dry-run flag to the publish cli

v1.0.1

• Fix a crash on startup

v1.0.0

• Initial release
• Includes the init, publish and config commands