Branch | Coverage | Codacy | Code Style | License |
---|---|---|---|---|
Master | ||||
Staging |
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.
To build the Docker image, simply run the Dockerfile
in the root of the repository.
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.
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