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

• TODO: INSERT LINK TO API DOCUMENTATION

• TODO: USE http://readthedocs.org to host the docs live on the internet

• TODO: CREATE API DOCS 😅

1. Python 3.6.9

2. pip 9.0.1

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

pip3 install -r requirements.txt

python3 nimbus_api.py

Run in the background

python3 nimbus_api.py&

pytest

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

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

Have a look at the v1.0 project board for TODOs!

If you are new to programming, then filter for the label

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.

GNU GPLv3

Michael Fekadu

John Waidhofer

Miles Aikens

Daniel DeFoe

Taylor Nguyen

Adam Perlin

Simon Ibssa

Kush Upadhyay

Ben Dahlgren

Tyler Campanile

Steven Bradley