base setup

at_django_boilerplate/history_tracker/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

at_django_boilerplate/history_tracker/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class HistoryTrackerConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'at_django_boilerplate.history_tracker'

at_django_boilerplate/history_tracker/models.py

@@ -0,0 +1,30 @@
+from django.db import models
+from at_django_boilerplate.utils.mixins import HashidSlugMixin
+
+from django.conf import  settings
+from django.utils import  timezone
+
+class TrackedChange(HashidSlugMixin):
+    CHANGE_TYPE = (('add','Add'),
+                   ('edit','Edit'),
+                   ('delete','Delete'),
+                   )
+    existing = models.TextField(null=True,blank=True)
+    change = models.TextField(null=True,blank=True)
+    change_type = models.CharField(choices=CHANGE_TYPE,default='add',max_length=10)
+    change_done_by = models.ForeignKey(settings.AUTH_USER_MODEL,
+                                       null=True,
+                                       blank=True,
+                                       on_delete=models.DO_NOTHING,
+                                       related_name='changes_by_me')
+    for_utility = models.ForeignKey('meters.UtilityModel',null=True,blank=True,on_delete=models.DO_NOTHING,related_name='utility_changes')
+    applied_on = models.DateTimeField(default=timezone.now)
+
+    def __str__(self):
+        if self.change_type=='add':
+            return f'{self.change_done_by} added {self.change}'
+        elif self.change_type=='edit':
+            return f'{self.change_done_by} updated {self.existing} to {self.change}'
+
+        elif self.change_type=='delete':
+            return f'{self.change_done_by} deleted {self.change}'

at_django_boilerplate/history_tracker/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

at_django_boilerplate/history_tracker/utils.py

@@ -0,0 +1,10 @@
+from at_django_boilerplate.history_tracker.models import  *
+
+
+
+def add_history(request=None,existing_message='',change_message='',utility=None,change_type="add"):
+    tmp = TrackedChange.objects.create(change_type=change_type,
+                                       existing=existing_message,
+                                       change=change_message,
+                                       change_done_by=request.user,
+                                       for_utility=utility)

at_django_boilerplate/history_tracker/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.