Add admin for easier setup

Author: martin056

config/django/base.py

@@ -48,7 +48,8 @@
     'django_celery_results',
     'django_celery_beat',
     'django_filters',
-    'corsheaders'
+    'corsheaders',
+    'django_extensions',
 ]
 
 INSTALLED_APPS = [

requirements/base.txt

@@ -11,3 +11,4 @@ whitenoise==5.3.0
 
 django-filter==21.1
 django-cors-headers==3.10.1
+django-extensions==3.1.5

styleguide_example/test_examples/admin.py

@@ -1,3 +1,45 @@
 from django.contrib import admin
 
-# Register your models here.
+from styleguide_example.test_examples.models import (
+    School,
+    SchoolClass,
+    Student,
+    Roster
+)
+
+
+@admin.register(School)
+class SchoolAdmin(admin.ModelAdmin):
+    list_display = ('name', 'slug', )
+
+
+@admin.register(Roster)
+class RosterAdmin(admin.ModelAdmin):
+    list_display = ('student', 'school_class', 'start_date', 'end_date', 'active', )
+    list_filter = ('student', 'school_class')
+
+
+class RosterStudentInline(admin.TabularInline):
+    model = Roster
+    fields = ('school_class', 'start_date', 'end_date', 'active', 'deactivated_at', )
+    extra = 1
+
+
+class RosterSchoolClassInline(admin.TabularInline):
+    model = Roster
+    fields = ('student', 'start_date', 'end_date', 'active', 'deactivated_at', )
+    extra = 1
+
+
+@admin.register(SchoolClass)
+class SchoolClassAdmin(admin.ModelAdmin):
+    list_display = ('name', 'short_name', 'slug', 'school', 'start_date', 'end_date', )
+    list_filter = ('school', )
+    inlines = (RosterSchoolClassInline, )
+
+
+@admin.register(Student)
+class StudentAdmin(admin.ModelAdmin):
+    list_display = ('email', 'identifier', 'school', )
+    list_filter = ('school', )
+    inlines = (RosterStudentInline, )

styleguide_example/test_examples/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 3.2.9 on 2021-11-18 09:46
+# Generated by Django 3.2.9 on 2021-11-18 10:11
 
 from django.db import migrations, models
 import django.db.models.deletion
@@ -39,12 +39,12 @@ class Migration(migrations.Migration):
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('name', models.CharField(max_length=255)),
+                ('short_name', models.CharField(max_length=50)),
                 ('slug', models.SlugField(max_length=255)),
+                ('start_date', models.DateField()),
+                ('end_date', models.DateField()),
                 ('school', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='school_classes', to='test_examples.school')),
             ],
-            options={
-                'unique_together': {('slug', 'school')},
-            },
         ),
         migrations.CreateModel(
             name='Roster',
@@ -53,11 +53,15 @@ class Migration(migrations.Migration):
                 ('start_date', models.DateField()),
                 ('end_date', models.DateField()),
                 ('active', models.BooleanField(default=True)),
-                ('deactivated_at', models.DateField(null=True)),
+                ('deactivated_at', models.DateField(blank=True, null=True)),
                 ('school_class', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rosters', to='test_examples.schoolclass')),
                 ('student', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='rosters', to='test_examples.student')),
             ],
         ),
+        migrations.AddConstraint(
+            model_name='schoolclass',
+            constraint=models.CheckConstraint(check=models.Q(('start_date__lt', django.db.models.expressions.F('end_date'))), name='school_class_start_before_end'),
+        ),
         migrations.AddConstraint(
             model_name='roster',
             constraint=models.CheckConstraint(check=models.Q(('start_date__lt', django.db.models.expressions.F('end_date'))), name='roster_start_before_end'),

styleguide_example/test_examples/models.py

@@ -29,13 +29,23 @@ def __str__(self):
 
 class SchoolClass(models.Model):
     name = models.CharField(max_length=255)
+    short_name = models.CharField(max_length=50)
     slug = models.SlugField(max_length=255)
     school = models.ForeignKey(School, related_name='school_classes', on_delete=models.CASCADE)
 
+    start_date = models.DateField()
+    end_date = models.DateField()
+
     class Meta:
-        unique_together = (
-            ('slug', 'school'),
-        )
+        constraints = [
+            models.CheckConstraint(
+                name="school_class_start_before_end",
+                check=Q(start_date__lt=F("end_date"))
+            )
+        ]
+
+    def __str__(self):
+        return f'{self.name} in {self.school}'
 
 
 class Roster(models.Model):
@@ -46,7 +56,7 @@ class Roster(models.Model):
     end_date = models.DateField()
 
     active = models.BooleanField(default=True)
-    deactivated_at = models.DateField(null=True)
+    deactivated_at = models.DateField(null=True, blank=True)
 
     class Meta:
         constraints = [