Flask API that wraps around the WattWatchers' API. Currently the only endpoint implemented is:
GET /monthly_energy_csv
Request parameters:
| parameter | format | required | Notes |
|---|---|---|---|
| api_key | string | Y | |
| device_id | string | Y | |
| from_ts | integer | N | default: 31 days from now |
| to_ts | integer | N | default: now |
| granularity | string | N | default: 30m |
The granularity is restricted to 30 minutes and above, to prevent making multiple calls. TODO: allow finer granularity by allowing multiple ww api calls until we cover 1 month worth of data.
c.f https://docs.wattwatchers.com.au/api/v3/endpoints.html#get-long-energydevice-id for more details.
Docker is used to containerise the Python + Flask application.
Build the docker image:
docker build -t wattwatchers-task:latest .
Run the image:
docker run -p 5000:5000 wattwatchers-task
See the results by opening the following URL in your browser: http://0.0.0.0:5000/monthly_energy_csv?api_key=key_4179959b76294b92a26eab1c47cc3f36&device_id=D704206228658
The tests are run automatically during the docker image build process.
I have opted for the most pragmatic "Single Module" structure, considering the project size and to save time with the project setup:
This is great for quick projects (like the ones used for tutorials), where you just need to serve a few routes and you’ve got less than a few hundred lines of application code.
http://exploreflask.com/en/latest/organizing.html#single-module