Skip to content
This repository has been archived by the owner on Aug 28, 2019. It is now read-only.

CIMAC-CIDC/cidc-api

Repository files navigation

Branch Coverage Codacy Code Style License
Master codecov Codacy Badge Code style: black License: MIT
Staging codecov Codacy Badge Code style: black License: MIT

CIDC-API

This is the API that powers the CIDC project. It interacts with a MongoDB and controlls both user uploads of data, and user requests for data. This is designed primarily to be run as a helm chart on kubernetes, but can also be run as a docker image.

Build

To build the Docker image, simply run the Dockerfile in the root of the repository.

Installation

This application is not meant to be run outside of the context of a container such as Docker, Docker-Compose, or Kubernetes. The easiest way to install this application without building it yourself is to copy the Helm chart from our helm repo. And then use helm install to install the service on your kubernetes cluster.

Running Tests

To run unit tests:

pipenv shell
pytest

To generate an XML for code coverage plugins:

pipenv shell
pytest --cov-report xml:coverage.xml --cov ./

To generate an HTML output:

pipenv shell pytest --html=report.html

About

CIDC Application Program Interface (API)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages