Skip to content

resource-watch/prep-nexgddp

Repository files navigation

PREP - NEXGDDP microservice

Build Status Test Coverage

Dependencies

Dependencies on other Microservices:

Getting started

Requirements

You need to install Docker in your machine if you haven't already Docker

Development

Follow the next steps to set up the development environment in your machine.

  1. Clone the repo and go to the folder
git clone https://github.com/resource-watch/prep-nexgddp.git
cd nex-gddp
  1. Run the ms.sh shell script in development mode.
./nexgddp.sh develop

If this is the first time you run it, it may take a few minutes.

Code structure

The API has been packed in a Python module (ps). It creates and exposes a WSGI application. The core functionality has been divided in three different layers or submodules (Routes, Services and Models).

There are also some generic submodules that manage the request validations, HTTP errors and the background tasks manager.

Tests

As this microservice relies on Google Earth Engine, tests require a valid storage.json or equivalent file. At the time of this writing, actual tests use mock calls, so the real credential are only needed because Google's library actually validates the credentials on startup.

Before you run the tests, be sure to install the necessary development libraries, using pip install -r requirements_dev.txt.

Actual test execution is done by running the pytest executable on the root of the project.