API Update

[bencleary]

Working with the package for the last year and a half now has opened up some areas where improvement is needed and required. This will be a breaking change but will allow for a more stable platform to build from.

Tasks

• Add pylint, black and other formatting tools
• Remove the models.models. import string, and tidy up imports
• Move the TimescaleModel to a utils package instead, it doesn't need to be the primary use as indicated by the multiple "why does 'time' need to be used statements"
• Update queryset methods to reflect the lastest implementation from TimescaleDB
• Add unit tests various parts
• Add integration tests using the example project
• Update the example project to show a more real-life example
• Add documentation site
• First pass of simple types

Potential or Investigative

• Look at an admin integration interface
• Retention periods
• Compression
• Distributed Tables

[bencleary]

Need to identify a testing plan as to where the most useful tests can be placed. A large chunk of the code base is behavioural rather than functional, i.e it requires something else to work, like the time_bucket function can only be used as part of a query. An initial testing plan is below:

Unit

• Field properties
• Util model properties

Integration (i.e requires a model and data to test)

• Expressions
• Aggregates
• Manages
• Querysets

All testing will be done through PyTest and will have a simple Django application configured for Timescale. It will require a timescale database instance to test against, i.e docker.

[bencleary]

Added more tests and better exception handling within the database expressions. Test suite is still growing and will require review.

[bencleary]

Tests have been added and structure for tests has been decided:

• Test aggregate methods
• Test expression methods
• Test full queries
• Test field methods and properties

[bencleary]

@schlunsen - are you able to review anything that is currently in progress, in-particular the test suites to see if i have missed anything obvious so far?

[bencleary]

During current work the following tasks needs to be completed:

• reduce duplicated logic in within expressions (checks for types, and formats, investigate using partials)
• TimeBucketGapFill test suite feels pretty flaky, add more edge cases and failing test suites
• Finish documentation for TimescaleModel - explain field names, and reasoning
• Add logging interface
• Mark Last & First as depreciated in this package
• Initial types for querysets and managers (both inputs and outputs)
• Expand docs for querysets and managers
• Add check for manager and quersets to confirm model has a hypertable to use