Support making migrations

README.md

@@ -60,3 +60,20 @@ To get started:
    ```bash
    pre-commit install
    ```
+
+## Making Migrations
+
+As a standalone Django application this plugin provides models to extend the
+Coldfront data model. A helper script is provided to generate migrations for
+these models. To use it, run the following command:
+
+```bash
+python makemigrations.py
+```
+
+This is equivalent to running `python manage.py makemigrations` in a Django
+project and all the same options are available. See options with:
+
+```bash
+python makemigrations.py --help
+```

makemigrations.py

@@ -0,0 +1,30 @@
+"""Minimal script to make migrations without a manage.py file."""
+
+import sys
+
+import django
+from django.conf import settings
+
+settings.configure(
+    INSTALLED_APPS=[
+        "django.contrib.auth",
+        "django.contrib.admin",
+        "django.contrib.contenttypes",
+        "django.contrib.sites",
+        "imperial_coldfront_plugin",
+    ],
+    # below checks do not need to pass to makemigrations
+    SILENCED_SYSTEM_CHECKS=[
+        "admin.E403",
+        "admin.E406",
+        "admin.E408",
+        "admin.E409",
+        "admin.E410",
+    ],
+)
+django.setup()
+
+if __name__ == "__main__":
+    from django.core.management import call_command
+
+    call_command("makemigrations", *sys.argv[1:])

pyproject.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 description = "A plugin for the Coldfront HPC management platform."
 authors = [
     { name = "Christopher Cave-Ayland", email = "[email protected]" },
-    { name = "Imperial College London RSE Team", email = "[email protected]" }
+    { name = "Imperial College London RSE Team", email = "[email protected]" },
 ]
 requires-python = "~=3.11"
 dependencies = [
@@ -42,7 +42,9 @@ requires = ["setuptools", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools.packages.find]
-exclude = ["htmlcov"] # Exclude the coverage report file from setuptools package finder
+exclude = [
+    "htmlcov",
+] # Exclude the coverage report file from setuptools package finder
 
 [tool.mypy]
 disallow_any_explicit = true
@@ -66,7 +68,7 @@ module = ["imperial_coldfront_plugin.oidc"]
 disallow_any_explicit = false
 
 [tool.pytest.ini_options]
-addopts = "-v --mypy -p no:warnings --cov=imperial_coldfront_plugin --cov-report=html --doctest-modules --ignore=docs"
+addopts = "-v --mypy -p no:warnings --cov=imperial_coldfront_plugin --cov-report=html --doctest-modules --ignore=docs --ignore=makemigrations.py"
 
 [tool.ruff]
 exclude = ["*/migrations"]
@@ -79,12 +81,15 @@ select = [
     "F",   # Pyflakes
     "I",   # isort
     "UP",  # pyupgrade
-    "RUF"  # ruff
+    "RUF", # ruff
 ]
 pydocstyle.convention = "google"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = ["D100", "D104"] # Missing docstring in public module, Missing docstring in public package
+"tests/*" = [
+    "D100",
+    "D104",
+] # Missing docstring in public module, Missing docstring in public package
 
 [tool.django-stubs]
-django_settings_module = "imperial_coldfront_plugin"  # a lie but seems to satisfy
+django_settings_module = "imperial_coldfront_plugin" # a lie but seems to satisfy