epiccli 2019.2

A command line interface for EPIC HPC

Epic by Zenotech - Command Line Interface

EPIC is a cloud platform for interfacing with HPC resources. This Python CLI demonstrates the pyepic module, which interfaces with the EPIC REST API.

Installation

From PyPi

You can install the package from PyPi using pip with pip install epiccli

From Github

Clone this repository and then install epiccli by navigating to the root directory and running pip install --editable .

Usage

To get started run epicli configure and enter your EPIC configuration details. This will generate the configuration file for the program. Multiple configuration files can be stored and can be chosen between using the --config flag. By default the file at ~/.epic/config is loaded.

Run epicli to list commands:

$ epiccli
Usage: epiccli [OPTIONS] COMMAND [ARGS]...

  CLI for communicating with the EPIC

Options:
  --config TEXT   Configuration file to load (default is ~/.epic/config)
  --help          Show this message and exit.

Commands:
  billing    Billing Management
  configure  Configure the CLI tool
  data       Data Management
  job        Manage your EPIC jobs
  queues     Queue Management
  teams      Team Management

About

The CLI is built using Click to handle boilerplate and is packaged over pypi.

The pyepic module manages interactions with the EPIC REST API. It uses the Requests and boto3 modules to make expose methods to the user abstracting the more complicated HTTP requests that occur under the hood.

For further documentation, a full API schema is available at https://epic.zenotech.com/api/v1/schema