py-api-vac-rnd-dash

Flask based API for Vaccine R&D Dashboard

Endpoint

Production: https://c19-vac-rnd-dash-api.herokuapp.com/

Staging: https://c19-vac-rnd-dash-staging-api.herokuapp.com/

Installation

Requirements

See condaenv.yml or Pipfile for minimum installation requirements in your environment

Use the package manager pip to install foobar.

1. Get Google Sheets API credentials.json from steps below and follow steps below
2. Add GMAPS_GEOCODING_API_KEY Key to .env
3. conda or pip install pipenv
4. pipenv install to install all dependencies
5. pipenv shell to activate python virtual environment
6. python run.py and navigate to the localhost endpoint

Conda Environment Setup

Install Miniconda

bash >> conda env create -f condaenv.yml

Start environment with: bash >> conda activate covidbe

How to access Google Sheet data using the Python API and convert to Pandas dataframe ?

1. Enable Google Sheets API
   • Step 1. Enable the Google Sheets API, download the credentials.json
   • Step 2. Download the credentials.json

How to access Google Geocoding API Key

1. Enable Google Geocoding API
2. Generate the API on GCP console
3. Add it to the .env file. See enviroment variables section

Usage

Run development server

From command line:

>> python run.py

From python shell:

# Not Implemented

Tests

Run unittests from application root folder (.../py-api-vac-rnd-dash/) with:

(Requirement Local) >> mkdir .../py-api-vac-rnd-dash/api/instance/logs
(Requirement Local) >> touch .../py-api-vac-rnd-dash/api/instance/logs/debg.log
>> python -m unittests discover

Testing the Full Application locally

Requires: redis server **May need three or more active terminals to run full server

1. Start redis

>> redis-server

2. Start worker

>> cd <RootDirectory>
>> python worker.py

3. Start Flask Application

>> cd <RootDirectory>
>> python run.py

4. Start a command terminal or postman/insomnia instance to send requests to the server at <Default: 127.0.0.1:5000/route>

Enviroment Variables

.env file can be added to the root folder in order to inject variables.

Variables being used:

GMAPS_GEOCODING_API_KEY=<key>

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GNU v3