Feat: districts Django app setup

.env.sample

@@ -7,6 +7,7 @@ DJANGO_SUPERUSER_PASSWORD=superuser12345!
 DJANGO_DB_RESET=true
 DJANGO_STORAGE_DIR=.
 DJANGO_DB_FILE=django.db
+DJANGO_DB_FIXTURES="pems/local_fixtures.json"
 
 # Streamlit
 STREAMLIT_LOCAL_PORT=8501

bin/makemigrations.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -eux
+
+# generate
+
+python manage.py makemigrations
+
+# reformat with black
+
+python -m black pems/districts/migrations/*.py

bin/reset_db.sh

@@ -22,3 +22,12 @@ if [[ $DB_RESET = true ]]; then
 else
     echo "DB_RESET is false, skipping"
 fi
+
+valid_fixtures=$(echo "$DJANGO_DB_FIXTURES" | grep -e fixtures\.json$ || test $? = 1)
+
+if [[ -n "$valid_fixtures" ]]; then
+    # load data fixtures
+    python manage.py loaddata "$DJANGO_DB_FIXTURES"
+else
+    echo "No JSON fixtures to load"
+fi

pems/districts/admin.py

@@ -0,0 +1,4 @@
+from django.contrib import admin
+from .models import District
+
+admin.site.register(District)

pems/districts/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class DistrictConfig(AppConfig):
+    name = "pems.districts"

pems/districts/migrations/0001_initial.py

@@ -0,0 +1,21 @@
+# Generated by Django 5.1.6 on 2025-04-15 20:59
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="District",
+            fields=[
+                ("id", models.AutoField(primary_key=True, serialize=False)),
+                ("number", models.TextField(blank=True, default="", help_text="The number of the Caltrans district")),
+                ("name", models.TextField(blank=True, default="", help_text="The short name of the Caltrans district")),
+            ],
+        ),
+    ]

pems/districts/models.py

@@ -0,0 +1,12 @@
+from django.db import models
+
+
+class District(models.Model):
+    """Data associated with a CalTrans District."""
+
+    id = models.AutoField(primary_key=True)
+    number = models.TextField(default="", blank=True, help_text="The number of the Caltrans district")
+    name = models.TextField(default="", blank=True, help_text="The short name of the Caltrans district")
+
+    def __str__(self):
+        return f"{self.number} - {self.name}"

pems/districts/urls.py

@@ -0,0 +1,8 @@
+"""
+URLConf for the districts app.
+"""
+
+app_name = "districts"
+urlpatterns = [
+    # /districts
+]

pems/districts/views.py

@@ -0,0 +1 @@
+# Create your views here.

pems/local_fixtures.json

@@ -0,0 +1,98 @@
+[
+  {
+    "model": "districts.district",
+    "pk": 1,
+    "fields": {
+      "number": "1",
+      "name": "Eureka"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 2,
+    "fields": {
+      "number": "2",
+      "name": "Redding"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 3,
+    "fields": {
+      "number": "3",
+      "name": "Marysville / Sacramento"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 4,
+    "fields": {
+      "number": "4",
+      "name": "Bay Area / Oakland"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 5,
+    "fields": {
+      "number": "5",
+      "name": "San Luis Obispo / Santa Barbara"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 6,
+    "fields": {
+      "number": "6",
+      "name": "Fresno / Bakersfield"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 7,
+    "fields": {
+      "number": "7",
+      "name": "Los Angeles / Ventura"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 8,
+    "fields": {
+      "number": "8",
+      "name": "San Bernardino / Riverside"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 9,
+    "fields": {
+      "number": "9",
+      "name": "Bishop"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 10,
+    "fields": {
+      "number": "10",
+      "name": "Stockton"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 11,
+    "fields": {
+      "number": "11",
+      "name": "San Diego"
+    }
+  },
+  {
+    "model": "districts.district",
+    "pk": 12,
+    "fields": {
+      "number": "12",
+      "name": "Orange County"
+    }
+  }
+]

pems/settings.py

@@ -31,6 +31,7 @@ def _filter_empty(ls):
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "pems.districts",
     "pems.streamlit_sample",
 ]
 

tests/pytest/pems/conftest.py

@@ -0,0 +1,10 @@
+import pytest
+
+from pems.districts.models import District
+
+
+@pytest.fixture
+def model_District():
+    district = District.objects.create(number="1", name="Eureka")
+
+    return district

tests/pytest/pems/districts/test_models.py

@@ -0,0 +1,6 @@
+import pytest
+
+
+@pytest.mark.django_db
+def test_District_str(model_District):
+    assert str(model_District) == "1 - Eureka"