Metadata-Version: 2.1
Name: epiccli
Version: 2019.1
Summary: A command line interface for EPIC HPC
Home-page: https://github.com/zenotech/epic-cli
Author: Zenotech Ltd
Author-email: support@zenotech.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: Click
Requires-Dist: requests
Requires-Dist: pyfiglet
Requires-Dist: boto3
Requires-Dist: botocore
Requires-Dist: pytz
Requires-Dist: python-dateutil
Requires-Dist: hurry.filesize

# Epic by Zenotech - Command Line Interface
[![Build
Status](https://travis-ci.org/zenotech/epic-cli.svg?branch=master)](https://travis-ci.org/zenotech/epic-cli) [![PyPI version](https://badge.fury.io/py/epiccli.svg)](https://badge.fury.io/py/epiccli) [![Updates](https://pyup.io/repos/github/zenotech/epic-cli/shield.svg)](https://pyup.io/repos/github/zenotech/epic-cli/)

[EPIC](epic.zenotech.com) 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](http://click.pocoo.org/6/) to handle boilerplate and is packaged over pypi. 

The `pyepic` module manages interactions with the EPIC REST API. It uses the [Requests](http://docs.python-requests.org/en/master/) and [boto3](https://boto3.readthedocs.io/en/latest/) 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


