api

Official API for the NIMBUS Voice Assistant accessible via HTTP REST protocol.

🚧 This API is still in-development, so expect the endpoints to be constantly changing until finalized.

GitHub Actions Status

Documentation

TODO: INSERT LINK TO API DOCUMENTATION
TODO: USE http://readthedocs.org to host the docs live on the internet
TODO: CREATE API DOCS 😅

Dev Environment Setup

Prerequisites

Python 3.6.9
pip 9.0.1

Database Configuration

Create a file called config.json that should include at least the following details of a MySQL database:

{
    ...
    "mysql": {
        "host": "HOSTNAME",
        "port": "PORT e.g. 3306",
        "user": "USERNAME",
        "password": "PASSWORD",
        "database": "DATABASE",
        ...
    }
    ...
}

You can also use config_SAMPLE.json as a reference

Contact anyone on the Data Team to get connection details for the Nimbus database

Install

pip3 install -r requirements.txt

Run the API server

python3 nimbus_api.py

Run in the background

python3 nimbus_api.py&

Run the tests

pytest

Python PEP8 Style Standards

Run the format script to automatically make our code look nice

./format.sh

Sometimes the format script is not enough, so run lint to manually style our code

./lint.sh

Deployment

What we use

A Linux server (e.g. Ubuntu 18.04.3 LTS) with open firewall at tcp:5000 for Flask, tcp:80 for http and tcp:443 for https and tcp:22 for ssh and tcp:3306 for mysql

See this documentation of the database deployment process