Merge pull request #35 from RSE-Sheffield/feat/lint

Add automatic Python code formatting

Author: f-allian

.flake8

@@ -0,0 +1,3 @@
+# https://flake8.pycqa.org/en/latest/user/configuration.html
+[flake8]
+max-line-length = 120

.github/workflows/lint-python.yaml

@@ -0,0 +1,25 @@
+name: Lint Python code
+on:
+  push:
+    branches:
+      - main
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install linters
+        run: pip install black flake8
+      - name: Lint Python code
+        run: |
+          dirs="SORT home survey invites"
+          black $dirs
+          flake8 $dirs
+      # 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

@@ -10,9 +10,10 @@
 https://docs.djangoproject.com/en/5.1/ref/settings/
 """
 
+import os
 from pathlib import Path
+
 from dotenv import load_dotenv
-import os
 
 load_dotenv()  # Load environment variables from .env file
 
@@ -24,7 +25,7 @@
 # See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = os.getenv('DJANGO_SECRET_KEY')
+SECRET_KEY = os.getenv("DJANGO_SECRET_KEY")
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
@@ -43,10 +44,8 @@
     "django.contrib.staticfiles",
     "django_bootstrap5",
     "django_extensions",
-    'debug_toolbar',
-
+    "debug_toolbar",
     # apps created by FA:
-
     "home",
     "survey",
     "invites",
@@ -60,16 +59,15 @@
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
-    'debug_toolbar.middleware.DebugToolbarMiddleware'
+    "debug_toolbar.middleware.DebugToolbarMiddleware",
 ]
 
 ROOT_URLCONF = "SORT.urls"
 
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
-        "DIRS": [BASE_DIR / 'static/templates']
-        ,
+        "DIRS": [BASE_DIR / "static/templates"],
         "APP_DIRS": True,
         "OPTIONS": {
             "context_processors": [
@@ -91,7 +89,7 @@
 DATABASES = {
     "default": {
         "ENGINE": "django.db.backends.sqlite3",
-        "NAME": BASE_DIR / 'db.sqlite3',
+        "NAME": BASE_DIR / "db.sqlite3",
         # "NAME": os.getenv("DB_NAME"),
         # "USER": os.getenv("DB_USER"),
         # "PASSWORD": os.getenv("DB_PASSWORD"),
@@ -136,8 +134,7 @@
 
 STATIC_URL = "static/"
 
-STATICFILES_DIRS = [BASE_DIR / 'static']
-
+STATICFILES_DIRS = [BASE_DIR / "static"]
 
 
 # Default primary key field type
@@ -155,15 +152,13 @@
 # FA: 30 minutes before automatic log out
 SESSION_COOKIE_AGE = 1800
 
-PASSWORD_RESET_TIMEOUT = 1800 # FA: default to expire after 30 minutes
+PASSWORD_RESET_TIMEOUT = 1800  # FA: default to expire after 30 minutes
 
 # FA: for local testing emails:
 
-EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
+EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
 
-AUTHENTICATION_BACKENDS = (
-    'django.contrib.auth.backends.ModelBackend',
-)
+AUTHENTICATION_BACKENDS = ("django.contrib.auth.backends.ModelBackend",)
 
 # For django-debug-toolbar
 INTERNAL_IPS = [
@@ -174,5 +169,4 @@
 
 # FA: for production:
 
-#EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"
-
+# EMAIL_BACKEND = "django.core.mail.backends.smtp.EmailBackend"

SORT/urls.py

@@ -14,9 +14,10 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+
 from django.conf import settings
 from django.contrib import admin
-from django.urls import path, include
+from django.urls import include, path
 
 urlpatterns = [
     path("admin/", admin.site.urls),
@@ -25,6 +26,7 @@
 
 if settings.DEBUG:
     import debug_toolbar
+
     urlpatterns += [
-        path('__debug__/', include(debug_toolbar.urls)),
-    ]
+        path("__debug__/", include(debug_toolbar.urls)),
+    ]

home/admin.py

@@ -1,3 +1,3 @@
-from django.contrib import admin
+# from django.contrib import admin
 
 # Register your models here.

home/forms.py

@@ -1,47 +1,50 @@
 from django import forms
-from django.contrib.auth.forms import UserCreationForm, AuthenticationForm, PasswordResetForm
-from django.core.exceptions import ValidationError
+from django.contrib.auth.forms import AuthenticationForm, UserCreationForm
 from django.contrib.auth.models import User
+from django.core.exceptions import ValidationError
 
 
 class ManagerSignupForm(UserCreationForm):
-    email = forms.EmailField(required=True, label='Email', error_messages={'required': 'Email is required.'})
-
+    email = forms.EmailField(
+        required=True, label="Email", error_messages={"required": "Email is required."}
+    )
 
     class Meta:
         model = User
-        fields = ('email', 'password1', 'password2')
+        fields = ("email", "password1", "password2")
 
     def clean_email(self):
-        email = self.cleaned_data.get('email')
+        email = self.cleaned_data.get("email")
         if User.objects.filter(email=email).exists():
             raise ValidationError("This email is already registered.")
         return email
 
     def save(self, commit=True):
         user = super().save(commit=False)
-        user.email = self.cleaned_data['email']
+        user.email = self.cleaned_data["email"]
         user.username = user.email
         if commit:
             user.save()
         return user
 
 
 class ManagerLoginForm(AuthenticationForm):
-    username = forms.EmailField(label='Email', max_length=60, widget=forms.EmailInput(attrs={'autofocus': True}))
+    username = forms.EmailField(
+        label="Email", max_length=60, widget=forms.EmailInput(attrs={"autofocus": True})
+    )
 
     class Meta:
         model = AuthenticationForm
-        fields = ['username', 'password']
+        fields = ["username", "password"]
 
 
 class UserProfileForm(forms.ModelForm):
     class Meta:
         model = User
-        fields = ['email', 'first_name', 'last_name']
+        fields = ["email", "first_name", "last_name"]
 
     def clean_email(self):
-        email = self.cleaned_data.get('email')
+        email = self.cleaned_data.get("email")
 
         if User.objects.exclude(pk=self.instance.pk).filter(email=email).exists():
             raise forms.ValidationError("This email is already in use.")
@@ -51,4 +54,4 @@ def save(self, commit=True):
         user = super().save(commit=False)
         if commit:
             user.save()
-        return user
+        return user

home/models.py

@@ -1,3 +1,3 @@
-from django.db import models
+# from django.db import models
 
 # Create your models here.

home/tests.py

@@ -1,3 +1,3 @@
-from django.test import TestCase
+# from django.test import TestCase
 
 # Create your tests here.

home/urls.py

@@ -1,20 +1,36 @@
 __author__ = "Farhad Allian"
 
-from django.urls import path, include
+from django.urls import include, path
+
 from . import views
 
 urlpatterns = [
-    path('', views.HomeView.as_view(), name='home'),
-    path('login/', views.LoginInterfaceView.as_view(), name='login'),
-    path('logout/', views.LogoutInterfaceView.as_view(), name='logout'),
-    path('signup/', views.SignupView.as_view(), name='signup'),
-    path('', include('survey.urls'), name='survey'),
-    path('invite/', include('invites.urls'), name='invites'),
-    path('profile/', views.ProfileView.as_view(), name='profile'),
-    path('password_reset/', views.CustomPasswordResetView.as_view(), name='password_reset'),
-    path('password_reset/done/', views.CustomPasswordResetDoneView.as_view(), name='password_reset_done'),
-    path('reset/<uidb64>/<token>/', views.CustomPasswordResetConfirmView.as_view(), name='password_reset_confirm'),
-    path('reset/done/', views.CustomPasswordResetCompleteView.as_view(), name='password_reset_complete'),
-    #path('password_reset/expired/', views.PasswordResetExpiredView.as_view(), name='password_reset_expired'),
-
-]
+    path("", views.HomeView.as_view(), name="home"),
+    path("login/", views.LoginInterfaceView.as_view(), name="login"),
+    path("logout/", views.LogoutInterfaceView.as_view(), name="logout"),
+    path("signup/", views.SignupView.as_view(), name="signup"),
+    path("", include("survey.urls"), name="survey"),
+    path("invite/", include("invites.urls"), name="invites"),
+    path("profile/", views.ProfileView.as_view(), name="profile"),
+    path(
+        "password_reset/",
+        views.CustomPasswordResetView.as_view(),
+        name="password_reset",
+    ),
+    path(
+        "password_reset/done/",
+        views.CustomPasswordResetDoneView.as_view(),
+        name="password_reset_done",
+    ),
+    path(
+        "reset/<uidb64>/<token>/",
+        views.CustomPasswordResetConfirmView.as_view(),
+        name="password_reset_confirm",
+    ),
+    path(
+        "reset/done/",
+        views.CustomPasswordResetCompleteView.as_view(),
+        name="password_reset_complete",
+    ),
+    # path('password_reset/expired/', views.PasswordResetExpiredView.as_view(), name='password_reset_expired'),
+]