Github actions for tests

Author: schlunsen

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Django timescaledb - Test basic project setup
+on:
+  push:
+    branches: [main]
+
+jobs:
+  setup-example-project:
+    runs-on: ubuntu-latest
+    env:
+      DB_NAME: test
+      DB_USER: postgres
+      DB_PORT: 5433
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: |-
+          cd example
+          pip install -r requirements.txt
+
+          # Start timescaledb
+          docker run -d --name timescaledb -p 5433:5432 -e POSTGRES_PASSWORD=password -e POSTGRES_DB=test timescale/timescaledb:2.1.1-pg13
+
+          # Wait for db to be ready
+          sleep 4
+
+          # Migrate
+          PYTHONPATH=../ python3 manage.py migrate
+
+      - name: Run tests
+        run: |-
+          cd example
+          PYTHONPATH=../ python3 manage.py test
+
+      - name: Test alter field
+        run: |-
+          cd example
+          sed -i -e 's/1 day/2 days/g' metrics/models.py
+          PYTHONPATH=../ python3 manage.py makemigrations
+          PYTHONPATH=../ python3 manage.py migrate

README.md

@@ -1,11 +1,8 @@
 # Django timescaledb
 
-
-
 [![PyPI version fury.io](https://badge.fury.io/py/django-timescaledb.svg)](https://pypi.python.org/pypi/django-timescaledb/)
 
-
-
+![Workflow](https://github.com/schlunsen/django-timescaledb/actions/workflows/test.yml/badge.svg)
 
 A database backend and tooling for Timescaledb.
 
@@ -55,8 +52,8 @@ TIMESCALE_DB_BACKEND_BASE = "django.contrib.gis.db.backends.postgis"
 
   class TimescaleModel(models.Model):
     """
-    A helper class for using Timescale within Django, has the TimescaleManager and 
-    TimescaleDateTimeField already present. This is an abstract class it should 
+    A helper class for using Timescale within Django, has the TimescaleManager and
+    TimescaleDateTimeField already present. This is an abstract class it should
     be inheritted by another class for use.
     """
     time = TimescaleDateTimeField(interval="1 day")
@@ -75,7 +72,7 @@ from timescale.db.models.models import TimescaleModel
 
 class Metric(TimescaleModel):
    temperature = models.FloatField()
-   
+
 
 ```
 
@@ -93,6 +90,7 @@ class Metric(models.Model):
 ```
 
 The name of the field is important as Timescale specific feratures require this as a property of their functions.
+
 ### Reading Data
 
 "TimescaleDB hypertables are designed to behave in the same manner as PostgreSQL database tables for reading data, using standard SQL commands."
@@ -144,14 +142,14 @@ As such the use of the Django's ORM is perfectally suited to this type of data.
     .values('device')
     .histogram(field='temperature', min_value=50.0, max_value=55.0, num_of_buckets=10)
     .annotate(Count('device')))
-    
+
   # expected output
 
   <TimescaleQuerySet [{'histogram': [0, 0, 0, 87, 93, 125, 99, 59, 0, 0, 0, 0], 'device__count': 463}]>
 ```
 
 ## Contributors
-
-* [Ben Cleary](https://github.com/bencleary)
-* [Jonathan Sundqvist](https://github.com/jonathan-s)
-* [Harsh Bhikadia](https://github.com/daadu)
+- [Rasmus Schlünsen](https://github.com/schlunsen)
+- [Ben Cleary](https://github.com/bencleary)
+- [Jonathan Sundqvist](https://github.com/jonathan-s)
+- [Harsh Bhikadia](https://github.com/daadu)

example/iot_example_app/.env

@@ -1,4 +1,5 @@
-DB_DATABASE=sample_app
-DB_USERNAME=username_here
-DB_PASSWORD=password_here
-DB_HOST=127.0.0.1
+DB_DATABASE=test
+DB_USERNAME=postgres
+DB_PASSWORD=password
+DB_HOST=127.0.0.1
+DB_PORT=5433

example/iot_example_app/settings.py

@@ -86,7 +86,8 @@
         'NAME': os.getenv('DB_DATABASE'),
         'USER': os.getenv('DB_USERNAME'),
         'PASSWORD': os.getenv('DB_PASSWORD'),
-        'HOST': os.getenv('DB_HOST')
+        'HOST': os.getenv('DB_HOST'),
+        'PORT': os.getenv('DB_PORT'),
     }
 }
 

example/metrics/migrations/0005_rename_sampletest_anothermetricfromtimescalemodel.py

@@ -0,0 +1,17 @@
+# Generated by Django 3.2 on 2021-04-20 19:57
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metrics', '0004_metric_device'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='SampleTest',
+            new_name='AnotherMetricFromTimeScaleModel',
+        ),
+    ]

example/metrics/models.py

@@ -18,5 +18,5 @@ class Metric(models.Model):
     timescale = TimescaleManager()
 
 
-class SampleTest(TimescaleModel):
+class AnotherMetricFromTimeScaleModel(TimescaleModel):
     value = models.FloatField(default=0.0)

example/requirements.txt

@@ -0,0 +1,4 @@
+Django
+psycopg2
+django-extensions
+python-dotenv