Temperature API

A flask api app for temperature platform based on flask-restful.

Environment

• Python 3.6 or later

Development manual

1. Clone

$ git clone http://10.161.32.68/F1054460/temp-api.git

2. Run flask app with pipenv

$ cd temp-api/
$ pipenv install
$ pipenv shell

$ export FLASK_CONFIG=development
$ flask run -h 0.0.0.0 -p 5000 --reload

Deployment

⚠️ Before deployment, confirm the configuration for different campuses. To switch campus, just edit CAMPUS_ID in file config.py, available parameters:

• 1 : Longhua
• 2 : Wuhan
• 3 : Chongqing
• 4 : Huasheng
• 5 : Mexico
• 6 : Malaysia

Automatic deployment

$ sudo chmod +x scripts/deploy.sh

$ ./scripts/deploy.sh

Manual deployment

1. Build docker image

$ docker build -t temp-api:latest -f Dockerfile .

2. Export the built image

$ docker save -o temp-api_latest.tar.gz

3. Send the image file to remote

$ rsync temp-api_latest.tar.gz USER@HOST:PORT:/PATH/TO/DIR

4. Load image from file (on remote server)

$ ssh USER@HOST:PORT

$ docker load -i /PATH/TO/DIR/temp-api_latest.tar.gz

5. Run for production

$ docker run -d -p 5857:5000 --env FLASK_CONFIG=production --restart always --name temp-api temp-api:latest

API

• Documentation
• Quick test:
  • Open Postman, then import collection from file: tests/temp-api_test-cases-for-Longhua.postman_collection.json
  • Run the collection, test cases should be 100% passed (only for Longhua).

Change Log

CHANGELOG

Authors

• Allen Shaw