Public | Automated Build

Last pushed: a year ago
Short Description
CHIVE REST API gateway
Full Description

C H I V E Application Service

Cisco Heat Indication Visualization Explorer Application Service

This is the Application microservice service for the CHIVE application

Application Details

This application will was developed based on microservice architecture and is wrapped in a Docker container. This application is a REST API that leverages Flask-RESTful API

Diagram

REST API Flow:

Installation

Prerequisites

Downloading

Instructions coming soon

Option A:

If you have git installed, clone the repository

git clone https://github.com/imapex/boilerplate

Option B:

If you don't have git, download a zip copy of the repository
and extract.

Option C:

The latest build of this project is also available as a Docker image from Docker Hub

docker pull username/image:tag

Installing

Provide instructions on how to install / use the application

Usage

Provide any relevant code samples / CLI's to leverage the code

python app.py

Development

Provide any notes for other contributors. This includes how to run tests / etc

Testing

The IMAPEX team should attempt to have unittests with 100% code coverage. An example test suite is contained
within the tests.py file for the boilerplate application

The tests are can be run in the following ways::

python tests.py

When adding additional code or making changes to the project, please ensure that unit tests are added to cover the
new functionality and that the entire test suite is run against the project before submitting the code.
Minimal code coverage can be verified using tools such as coverage.py.

For instance, after installing coverage.py, the toolkit can be run with the command::

coverage run tests.py

and an HTML report of the code coverage can be generated with the command::

coverage html

License

LICENSE

Docker Pull Command
Owner
clintmann
Source Repository