Fixed formatter (was expecting a subdirectory), added install prereqs to docs workflow.

Author: smangham

.github/workflows/docs.yaml

@@ -12,6 +12,9 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions-ext/python/setup@main
+      - run: | 
+          sudo apt-get update
+          sudo apt-get install -y libldap2-dev libssl-dev libsasl2-dev
       - run: uv pip install .
       - run: uv pip install yardang
       - run: yardang build

Makefile

@@ -25,8 +25,8 @@ lint:  ## run python linter with ruff
 lints: lint
 
 fix:  ## fix python formatting with ruff
-	python -m ruff check --fix teaching_time_tool
-	python -m ruff format teaching_time_tool
+	python -m ruff check --fix teaching_time_tool app
+	python -m ruff format teaching_time_tool app
 
 # alias
 format: fix

app/admin.py

@@ -17,6 +17,7 @@ class AcademicGroupAdmin(ModelAdmin):
     Admin class for the AcademicGroup model.
     Uses the default settings, but here in case it needs expanding.
     """
+
     pass
 
 
@@ -26,6 +27,7 @@ class UnitAdmin(ModelAdmin):
     Admin class for the Module model.
     Uses the default settings, but here in case it needs expanding.
     """
+
     pass
 
 
@@ -35,6 +37,7 @@ class AssignmentAdmin(ModelAdmin):
     Admin class for the Assignment model.
     Uses the default settings, but here in case it needs expanding.
     """
+
     pass
 
 
@@ -44,6 +47,7 @@ class TaskAdmin(ModelAdmin):
     Admin class for the Task model.
     Uses the default settings, but here in case it needs expanding.
     """
+
     pass
 
 
@@ -53,6 +57,7 @@ class StandardLoadAdmin(ModelAdmin):
     Admin class for the StandardLoad model.
     Uses the default settings, but here in case it needs expanding.
     """
+
     pass
 
 
@@ -62,4 +67,5 @@ class StaffAdmin(ModelAdmin):
     Admin class for the Staff model.
     Uses the default settings, but here in case it needs expanding.
     """
+
     pass

app/assets.py

@@ -3,19 +3,17 @@
 from iommi import Asset
 
 mathjax_js: Dict[str, Any] = dict(
-    mathjax_inline = Asset.js(
-        attrs__src='/static/js/mathjax-inline.js'
-    ),
-    mathjax_js = Asset.js(
+    mathjax_inline=Asset.js(attrs__src="/static/js/mathjax-inline.js"),
+    mathjax_js=Asset.js(
         attrs__id="MathJax-script",
         attrs__src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js",
         attrs__async=True,
-    )
+    ),
 )
 
 autosize_js: Dict[str, Any] = dict(
-    autoexpand_js = Asset.js(
-        attrs__src='/static/js/autosize.js',
+    autoexpand_js=Asset.js(
+        attrs__src="/static/js/autosize.js",
         attrs__defer=True,
     )
 )

app/auth.py

@@ -1,6 +1,7 @@
 """
 Adds access-checking functions that test the permissions on the model.
 """
+
 from typing import Any, Callable, Type, Unpack
 
 from django.contrib.auth.models import AbstractUser, AnonymousUser
@@ -17,6 +18,7 @@ def has_access_decoder(model: Type[ModelCommon], message: str) -> Callable[[str,
     :param message: The message to show on failed access.
     :return: A function that decodes access for that model
     """
+
     def has_access_decoder_inner(string: str, request: HttpRequest, **_: Unpack[Any]) -> ModelCommon:
         """
         Given a URL string key and a user, returns the model associated with that string if the user has permission.
@@ -34,7 +36,7 @@ def has_access_decoder_inner(string: str, request: HttpRequest, **_: Unpack[Any]
     return has_access_decoder_inner
 
 
-def has_staff_access(user: AbstractUser|AnonymousUser) -> bool:
+def has_staff_access(user: AbstractUser | AnonymousUser) -> bool:
     """
     Checks if the user is signed in and staff, or if security is off for debugging.
 

app/config.py

@@ -2,4 +2,4 @@
 
 
 class MyConfig(AppConfig):
-    name = 'cfg'
+    name = "cfg"

app/forms/__init__.py

@@ -1 +1 @@
-from django import forms
+from django import forms

app/forms/academic_group.py

@@ -6,13 +6,16 @@
 
 class AcademicGroupDetailForm(Form):
     class Meta:
-        auto=dict(
+        auto = dict(
             model=AcademicGroup,
             exclude=[
-                'code', 'short_name', 'name', 'load_balance_final',
-            ]
+                "code",
+                "short_name",
+                "name",
+                "load_balance_final",
+            ],
         )
-        fields=dict(
+        fields = dict(
             load_balance=Field.integer(
                 display_name="Load Balance",
                 group="Row",
@@ -24,8 +27,8 @@ class Meta:
                 non_editable_input__attrs__class=lambda field, **_: get_balance_classes_form(field.value),
             ),
         )
-        editable=False
-        include=lambda request, **_: request.user.is_staff
-        instance=lambda academic_group, **_: academic_group
+        editable = False
+        include = lambda request, **_: request.user.is_staff
+        instance = lambda academic_group, **_: academic_group
 
         iommi_style = floating_fields_style

app/forms/assignment.py

@@ -9,15 +9,18 @@
 
 
 class AssignmentTaskUniqueForm(Form):
-    """
+    """ """
 
-    """
     class Meta:
         auto = dict(
             model=Assignment,
             include=[
-                'task', 'staff', 'students', 'is_first_time', 'is_provisional',
-            ]
+                "task",
+                "staff",
+                "students",
+                "is_first_time",
+                "is_provisional",
+            ],
         )
         title = "Assignment"
         fields = dict(
@@ -34,13 +37,13 @@ class Meta:
             is_first_time__group="Row",
             is_provisional__group="Row",
         )
-        extra__redirect_to='.'
-        actions__submit=dict(
+        extra__redirect_to = "."
+        actions__submit = dict(
             display_name="Save",
             attrs__class={
                 "btn-primary": False,
                 "btn-success": True,
-            }
+            },
         )
 
         @staticmethod

app/forms/info.py

@@ -11,19 +11,24 @@ class InfoForm(Form):
 
     Redirects to the 'page' the info is for on submission.
     """
+
     class Meta:
         auto = dict(
             model=Info,
-            include=['text'],
+            include=["text"],
         )
         fields__text__template = Template("{% load markdownify %}{{ field.value | markdownify }}")
-        attrs__class = {'position-relative': True}
+        attrs__class = {"position-relative": True}
         actions__edit = Action.icon(
             display_name=" ",  # If it's empty/none, it's 'Edit'
             icon=settings.ICON_EDIT,
             attrs__class={
-                'btn': True, 'btn-warning': True, 'btn-sm': True,
-                'position-absolute': True, 'bottom-0': True, 'end-0': True,
+                "btn": True,
+                "btn-warning": True,
+                "btn-sm": True,
+                "position-absolute": True,
+                "bottom-0": True,
+                "end-0": True,
             },
             include=lambda user, **_: user.is_staff,
             attrs__href=lambda instance, **_: instance.get_edit_url(),