2714 new data service

.github/workflows/reusable-data-service-ci.yml

@@ -0,0 +1,38 @@
+name: Re-usable Data Service Python CI
+
+on:
+  push:
+    branches: [main, '*-stable']
+    paths:
+    - '.github/workflows/reusable-data-service-ci.yml'
+    - 'data-serving/reusable-data-service/**'
+  pull_request:
+    paths:
+    - '.github/workflows/reusable-data-service-ci.yml'
+    - 'data-serving/reusable-data-service/**'
+  workflow_dispatch:
+
+jobs:
+  ci:
+    runs-on: ubuntu-20.04
+    defaults:
+      run:
+        working-directory: data-serving/reusable-data-service
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10.5'
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Run python tests
+      run: |
+        pip install poetry
+        poetry install
+        poetry run pytest

data-serving/README.md

@@ -1,8 +1,21 @@
 # All things data
 
+# Emerging outbreaks
+
+Any new outbreak that is tracked by Global.health will use the `reusable-data-service` for CRUD operations on line list cases.
+It incorporates a simple "day zero" schema along with facilities for flexibly extending the data model.
+
+## Configuration
+
+TBD as the service gets written!
+
+# COVID-19 instances
+
+The `data-service` folder contains the service for CRUD operations involving the COVID-19 schema.
+
 ## Database design
 
-G.h case data, as well as the source, user, and session data for the curator portal, is stored in a MongoDB database.
+G.h COVID-19 case data, as well as the source, user, and session data for the curator portal, is stored in a MongoDB database.
 
 We have multiple instances of MongoDB, ranging from local instances for development, to dev and qa (for
 https://dev-data.covid-19.global.health/ and https://qa-data.covid-19.global.health in the case of COVID-19 data),
@@ -154,9 +167,3 @@ Add your index as a [migration](https://github.com/globaldothealth/list/tree/mai
 ##### Sample PRs
 
 * [Adding a new compound index](https://github.com/globaldothealth/list/pull/701/files)
-
-## Extending to new outbreaks
-
-Our database design is intended to be flexible enough to support future outbreaks. To spin up an instance of the curator
-service with a different dataset, create a new database in your MongoDB instance and
-[point the curator portal to it](https://github.com/globaldothealth/list/blob/main/dev/docker-compose.yml).

data-serving/reusable-data-service/README.rst

@@ -0,0 +1,11 @@
+#####################
+Reusable Data Service
+#####################
+
+Introduction
+============
+
+The Global.health reusable data service takes lessons learned from the
+COVID-19 data service (see ../data-service) and provides a scalable,
+extensible application server for CRUD operations on line list data
+for infectious disease outbreaks.