tnewman / piot Goto Github PK

As an administrator, I would like an installation guide, so I know how to configure the distance sensor and the PIoT software.

As an administrator, I would like the sensor reading script to shutdown gracefully when it is interrupted to make sure that data is not lost.

As an administrator/developer, I would like all scripts to log to standard out, so that I can debug problems through systemd logging. I would prefer all of the logs to be configured through the same Python module to prevent code duplication.

As an administrator, I would like gunicorn and sensor reading to be controllable through systemd services, so the system can handle startup and shutdown for me.

As a developer, I want the Twilio Config to be injected via module-level variables, so that I can mock it.

As a developer, I would like the documentation hosted on Read the Docs, so it is auto-hosted and auto-generated.

As a user, I would like sensors to be sorted in descending order by date, so that I have access to the most up to date information.

As a developer, I would like to know how fast the database grows, so informed decisions can be made when telling administrators when and how to purge old data.

Include breakout board and case in docs

As a developer, I would like complete class-level documentation, so I can figure out what each class does and receive helpful IDE completion.

As an administrator, I would like to know how to properly set up the ownership for the distance sensor.

The sensor value should be included in the notification.

As an administrator, I would like an auto-installation script, so I can just install the software and not worry about the details.

Take clearer pictures for docs.

As a developer, I want unit tests added to Flask, so I can be confident that I am not breaking anything.

As an administrator, I would like notification failure to be handled gracefully:

1. Shorter timeouts, so other sensors are not blocked for as long
2. try catch log notifications, so other notifications/sensors can proceed

When the database grows to a few thousand records, too many records are fetched from the database at a time, causing slow page rendering and crashes. The user should be able to page through the sensor readings.