Merge branch 'dev' into chore/remove-settings

Author: twinkarma

.github/workflows/lint-python.yaml

@@ -2,6 +2,8 @@ name: Lint Python code
 on:
   push:
     branches: [ "main", "dev" ]
+  pull_request:
+    branches: [ "main", "dev" ]
 jobs:
   lint:
     runs-on: ubuntu-24.04
@@ -16,10 +18,3 @@ jobs:
           isort $dirs --skip-glob '*/migrations/*'
           black $dirs --exclude '/migrations/'
           flake8 $dirs --exclude '*/migrations/*'
-      # Suggest merging any changes
-      - name: Create Pull Request
-        # https://github.com/marketplace/actions/create-pull-request
-        uses: peter-evans/create-pull-request@v7
-        with:
-          body: "Python code reformatted with black and isort"
-          branch: "chore/python-formatting"

SORT/settings.py

@@ -65,6 +65,8 @@ def cast_to_boolean(obj: Any) -> bool:
     "django_extensions",
     "debug_toolbar",
     "qr_code",
+    "crispy_forms",
+    "crispy_bootstrap5",
     # apps created by FA:
     "home",
     "survey",
@@ -172,6 +174,7 @@ def cast_to_boolean(obj: Any) -> bool:
 
 # Email settings
 # https://docs.djangoproject.com/en/5.1/topics/email/#email-backends
+
 EMAIL_BACKEND = os.getenv("DJANGO_EMAIL_BACKEND", "django.core.mail.backends.smtp.EmailBackend")
 EMAIL_HOST = os.getenv("DJANGO_EMAIL_HOST")
 EMAIL_PORT = int(os.getenv("DJANGO_EMAIL_PORT", 465))
@@ -198,7 +201,9 @@ def cast_to_boolean(obj: Any) -> bool:
 
 # Vite integration
 VITE_BASE_URL = "http://localhost:5173"  # Url of vite dev server
-VITE_STATIC_DIR = "ui-components"  # Path to vite-generated asset directory in the static folder
+VITE_STATIC_DIR = (
+    "ui-components"  # Path to vite-generated asset directory in the static folder
+)
 VITE_MANIFEST_FILE_PATH = os.path.join(VITE_STATIC_DIR, "manifest.json")
 
 # FA: for production:
@@ -209,7 +214,17 @@ def cast_to_boolean(obj: Any) -> bool:
 
 # File uploading
 MEDIA_ROOT = os.getenv("DJANGO_MEDIA_ROOT", BASE_DIR / "uploads")
-MEDIA_SUPPORTED_EXTENSIONS = [".jpg", ".jpeg", ".png", ".pdf", ".doc", ".docx", ".txt", ".csv", ".json"]
+MEDIA_SUPPORTED_EXTENSIONS = [
+    ".jpg",
+    ".jpeg",
+    ".png",
+    ".pdf",
+    ".doc",
+    ".docx",
+    ".txt",
+    ".csv",
+    ".json",
+]
 
 # Security settings
 SESSION_COOKIE_SECURE = cast_to_boolean(
@@ -240,3 +255,8 @@ def cast_to_boolean(obj: Any) -> bool:
     "Midwives": "sort_only_config_midwives.json",
     "NMAHPs": "sort_only_config_nmahps.json",
 }
+
+# Crispy enables Bootstrap styling on Django forms
+# https://django-crispy-forms.readthedocs.io/en/latest/install.html
+CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"
+CRISPY_TEMPLATE_PACK = "bootstrap5"

deploy.sh

@@ -18,7 +18,6 @@ pip="$venv_dir/bin/pip"
 python_version="python3.12"
 python="$venv_dir/bin/python"
 env_file="$sort_dir/.env"
-frontend_dir="$sort_dir/assets/sort-survey-configurator"
 node_version=20
 
 # Install British UTF-8 locale so we can use this with PostgreSQL.

home/admin.py

@@ -1,11 +1,6 @@
 from django.contrib import admin
 
-from .models import (
-    Organisation,
-    OrganisationMembership,
-    Project,
-    User,
-)
+from .models import Organisation, OrganisationMembership, Project, User
 
 
 # Register your models here.

home/management/commands/clear_orphaned_files.py

@@ -1,30 +1,33 @@
 from pathlib import Path
-from django.core.management.base import BaseCommand, CommandError
+
 from django.conf import settings
-from survey.models import SurveyFile, SurveyEvidenceFile
+from django.core.management.base import BaseCommand
+
+from survey.models import SurveyEvidenceFile, SurveyFile
 
 
 class Command(BaseCommand):
     help = "Clear orphaned uploaded files uploaded by the user"
 
-
     def handle(self, *args, **options):
 
         upload_root = Path(settings.MEDIA_ROOT)
 
         # Gets all file in the uploads folder, delete any that's not in use
-        for (dirpath, dir_names, file_names) in upload_root.walk():
+        for dirpath, dir_names, file_names in upload_root.walk():
             for file_name in file_names:
-                file_path = dirpath/file_name
+                file_path = dirpath / file_name
                 relative_path = file_path.relative_to(upload_root)
-                if (SurveyEvidenceFile.objects.filter(file=str(relative_path)).count() < 1
-                        and SurveyFile.objects.filter(file=str(relative_path)).count() < 1):
+                if (
+                    SurveyEvidenceFile.objects.filter(file=str(relative_path)).count()
+                    < 1
+                    and SurveyFile.objects.filter(file=str(relative_path)).count() < 1
+                ):
                     print(f"Deleting {file_path}")
                     file_path.unlink(missing_ok=True)
 
         self.clear_empty_directories(settings.MEDIA_ROOT)
 
-
     def clear_empty_directories(self, root_dir: str):
         for item in Path(root_dir).iterdir():
             if item.is_dir():

home/models.py

@@ -6,7 +6,7 @@
 from django.db import models
 from django.urls import reverse
 
-from .constants import ROLE_PROJECT_MANAGER, ROLES, ROLE_ADMIN
+from .constants import ROLE_ADMIN, ROLE_PROJECT_MANAGER, ROLES
 
 
 class UserManager(BaseUserManager):

home/services/__init__.py

@@ -5,7 +5,6 @@
 # Create instances for use in views
 
 
-
 __all__ = [
     "BasePermissionService",
     "ProjectService",

home/services/organisation.py

@@ -1,18 +1,14 @@
 """
 Organisation service with integrated permissions
 """
+
 from typing import Dict, Optional, Set
-from django.core.exceptions import PermissionDenied
+
 from django.db.models import Count
 from django.db.models.query import QuerySet
 
 from ..constants import ROLE_ADMIN, ROLE_PROJECT_MANAGER
-from ..models import (
-    Organisation,
-    OrganisationMembership,
-    Project,
-    User
-)
+from ..models import Organisation, OrganisationMembership, Project, User
 from .base import BasePermissionService, requires_permission
 
 
@@ -21,7 +17,9 @@ class OrganisationService(BasePermissionService):
 
     def get_user_role(self, user: User, organisation: Organisation) -> Optional[str]:
         try:
-            membership = organisation.organisationmembership_set.filter(user=user).first()
+            membership = organisation.organisationmembership_set.filter(
+                user=user
+            ).first()
             return membership.role if membership else None
         except AttributeError:  # In case user is AnonymousUser
             return None
@@ -77,7 +75,7 @@ def get_user_organisation_ids(self, user: User) -> Set[int]:
 
     @requires_permission("edit", obj_param="organisation")
     def update_organisation(
-            self, user: User, organisation: Organisation, data: Dict
+        self, user: User, organisation: Organisation, data: Dict
     ) -> Organisation:
         """Update organisation with provided data"""
         for key, value in data.items():
@@ -86,7 +84,7 @@ def update_organisation(
         return organisation
 
     def create_organisation(
-            self, user: User, name: str, description: str = None
+        self, user: User, name: str, description: str = None
     ) -> Organisation:
         """
         Create a new organisation, and add the creator to it.
@@ -101,11 +99,11 @@ def create_organisation(
 
     @requires_permission("edit", obj_param="organisation")
     def add_user_to_organisation(
-            self,
-            user: User,
-            user_to_add: User,
-            organisation: Organisation,
-            role: str,
+        self,
+        user: User,
+        user_to_add: User,
+        organisation: Organisation,
+        role: str,
     ) -> OrganisationMembership:
         """Add a user to an organisation with specified role"""
         if role not in [ROLE_ADMIN, ROLE_PROJECT_MANAGER]:
@@ -119,15 +117,15 @@ def add_user_to_organisation(
 
     @requires_permission("edit", obj_param="organisation")
     def remove_user_from_organisation(
-            self, user: User, organisation: Organisation, removed_user: User
+        self, user: User, organisation: Organisation, removed_user: User
     ) -> None:
         """Remove user from organisation"""
         OrganisationMembership.objects.filter(
             user=removed_user, organisation=organisation
         ).delete()
 
     def get_organisation_projects(
-            self, organisation: Organisation, user: User = None, with_metrics: bool = True
+        self, organisation: Organisation, user: User = None, with_metrics: bool = True
     ) -> QuerySet[Project]:
         """Get projects for an organisation with optional metrics"""
         if not self.can_view(user, organisation):
@@ -137,15 +135,15 @@ def get_organisation_projects(
 
         # Add metrics
         if with_metrics:
-            projects = base_query.annotate(
+            base_query = base_query.annotate(
                 survey_count=Count("survey__id", distinct=True),
             ).select_related("created_by", "organisation")
 
         return base_query.order_by("-created_at")
 
     @requires_permission("view", obj_param="organisation")
     def get_organisation_members(
-            self, user: User, organisation: Organisation
+        self, user: User, organisation: Organisation
     ) -> QuerySet[OrganisationMembership]:
         """Get all members of an organisation with their roles"""
         return OrganisationMembership.objects.filter(

home/services/project.py

@@ -2,16 +2,13 @@
 Project service with integrated permissions
 """
 
-from typing import Optional, Dict
-from django.db.models.query import QuerySet
+from typing import Dict, Optional
+
 from django.core.exceptions import PermissionDenied
+from django.db.models.query import QuerySet
 
 from ..constants import ROLE_ADMIN, ROLE_PROJECT_MANAGER
-from ..models import (
-    Organisation,
-    Project,
-    User,
-)
+from ..models import Organisation, Project, User
 from .base import BasePermissionService, requires_permission
 from .organisation import organisation_service
 
@@ -24,7 +21,7 @@ def get_user_role(self, user: User, project: Project) -> Optional[str]:
         try:
             return project.organisation.get_user_role(user)
         except (
-                AttributeError
+            AttributeError
         ):  # In case user is AnonymousUser or organisation method fails
             return None
 
@@ -38,7 +35,7 @@ def can_edit(self, user: User, project: Project) -> bool:
         return role in [ROLE_ADMIN, ROLE_PROJECT_MANAGER]
 
     def can_create(self, user: User, organisation: Organisation) -> bool:
-        """ Needs to be at least a member of an organisation to create a project """
+        """Needs to be at least a member of an organisation to create a project"""
         role = organisation_service.get_user_role(user, organisation)
         return role in [ROLE_ADMIN, ROLE_PROJECT_MANAGER]
 
@@ -62,7 +59,7 @@ def get_project(self, user: User, project: Project) -> Project:
 
     @requires_permission("create", obj_param="organisation")
     def create_project(
-            self, user: User, name: str, organisation: Organisation, description: str = None
+        self, user: User, name: str, organisation: Organisation, description: str = None
     ) -> Project:
         """Create a new project"""
         if not self.can_create(user, organisation):

home/templates/home/password_reset_confirm.html

@@ -35,7 +35,7 @@
                            {% if field.field.required %}required{% endif %} />
                 </div>
             {% endfor %}
-            <button type="submit" class="btn btn-primary w-100">Send Password Reset Email</button>
+            <button type="submit" class="btn btn-primary w-100">Save password</button>
         </form>
         <div class="text-center mt-2 small-text" style="font-size: 0.7rem;">
             <a href="{% url 'login' %}">Already have an account? Login here</a>