Skip to content

Commit

Permalink
Updates to CLI to use PyEPIC rather than requests and boto
Browse files Browse the repository at this point in the history
  • Loading branch information
mike-jt79 committed Jan 28, 2021
1 parent fa0bd9f commit 2f50573
Show file tree
Hide file tree
Showing 12 changed files with 230 additions and 575 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
# 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/)

[![PyPI version](https://badge.fury.io/py/epiccli.svg)](https://badge.fury.io/py/epiccli)
[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 `epic configure` and enter your EPIC configuration details. This will generate the configuration file for the program.

Expand All @@ -37,6 +32,6 @@ Run `epic` to list commands:
## 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.
The `pyepic` module manages interactions with the EPIC REST API.

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

0 comments on commit 2f50573

Please sign in to comment.