debrief / python-import-library Goto Github PK

The existing API includes methods to store elements in a temporary structure prior to being pushed into the database.

We're going to modify this temporary structure, to ensure that data values that require units are represented accordingly. Examples of this are Speed and Direction. Each of these can take values with different types of units. Speed, for example could be expressed in metres/second or miles/hour.

This library allows the specification of values with units: https://pint.readthedocs.io/en/0.9/

Steps:

1. Refactor RepLine into a separate module
2. Rename RepLine to State
3. Introduce setters for all optional entities (see which elements are optional/required in file titled State.sql
4. Modify setters for Speed and Direction to take a quantity-with-units from Pint library
5. Modify RepFile to parse quantities-with-units. The speed in the file is in Knots and the heading is in Degrees
6. Modify getters for Speed and Direction to supply speed and direction in m/second and Radians.
7. Introduce unit test (in Tests folder) to demonstrate creating quantity-with-units objects, and to test that setSpeed(valueInKnots) gets correctly converted for getSpeed() (in metres/second), and that setDirection(...) and getDirection() do correct conversion.

We currently have a combination of source and non-source folders at the top level of our project.

I think we should find a Python project layout standard. Once the structure is agreed, we should refactor the project to match the new layout.

I'd like a proposal for a new project layout to be described in this document: https://docs.google.com/document/d/1fsunCg6MhjTP-EZGNpZmbh8CwKXIMjX72XGLUXJoTiY/edit#

Hopefully the proposal will link to online references/guides, to verify that we're following an established pattern.

I'd like this plan to also include a plan for the use of Python Packages, and where we require __init__.py files.

We'll soon have unit tests that use PostGres.

They only run if the user has PostGres available.

It's important that we have PostGres available for the Travis CI process.

Details on configuring Travis here:
https://docs.travis-ci.com/user/database-setup/#postgresql

While we're at it, we should probably install/configure PostGIS too:
https://docs.travis-ci.com/user/database-setup/#using-postgis

A website provides free hosting to code coverage results for Open Source projects.

We should use it, for us to have a deeper understanding of our code coverage:
https://github.com/codecov/example-python