Fix some pylint issues, improve initadmin, add env documentation, replace decouple

Author: tgrants

.github/workflows/lint.yml

@@ -20,4 +20,4 @@ jobs:
           pip install -r requirements.txt
 
       - name: Run Pylint
-        run: pylint . --fail-under 7.0
+        run: pylint . --fail-under 8.0

README.md

@@ -31,8 +31,7 @@ For more detailed instructions, see the [documentation](docs/).
 - Clone this repository `git clone https://github.com/tgrants/grade-check.git`
 - Set environment variables
 	- Copy template `cp .env.example .env`
-	- Edit it `nano .env`
-		- if `DJANGO_SECRET_KEY` is left empty, it will be generated when the app is run for the first time
+	- Edit it `nano .env` (see the [environment variable documentation](docs/enviornment-variables.md))
 - Install [Docker](https://docs.docker.com/engine/install/debian/)
 	- Get docker compose `sudo apt install docker-compose`
 	- Enable docker `sudo systemctl enable docker`
@@ -45,10 +44,6 @@ For more detailed instructions, see the [documentation](docs/).
 
 ## Updating
 
-> [!WARNING]
->
-> Migrating your data to a new version is currently not supported, but will be in the future.
-
 - Read the [changelogs](https://github.com/tgrants/grade-check/releases)
 - Pull the latest changes `git pull`
 - Make sure `.env` has the same values as `.env.example`

core/admin.py

@@ -1,13 +1,11 @@
-from django.contrib import admin
-from django.urls import path
 from django import forms
+from django.contrib import admin, messages
+from django.contrib.admin.models import LogEntry, ADDITION
 from django.contrib.auth.models import User
+from django.contrib.contenttypes.models import ContentType
 from django.shortcuts import render, redirect
-from django.contrib import messages
+from django.urls import path
 
-from django.contrib.admin.models import LogEntry, ADDITION
-from django.contrib.contenttypes.models import ContentType
-from django.utils.encoding import force_str
 
 class BulkUserUploadForm(forms.Form):
 	data = forms.CharField(

core/management/commands/initadmin.py

@@ -1,17 +1,66 @@
-from django.core.management.base import BaseCommand
+"""
+Management command to create a default Django superuser.
+
+This command creates a superuser if none exist, using either provided command-line
+arguments, environment variables, or fallback defaults. Intended for easy setup
+in development or initial deployments.
+"""
+
+import os
+
+from django.core.management import color_style
+from django.core.management.base import BaseCommand, CommandError
 from django.contrib.auth import get_user_model
 
+
 class Command(BaseCommand):
+	"""
+	Django management command to create a default superuser.
+
+	Optional arguments:
+	--username: specify the superuser username (default 'admin' or env var)
+	--email: specify the superuser email address (default 'admin@email.invalid' or env var)
+	--password: specify the superuser password (default 'gradecheck' or env var)
+
+	If any user exists already, user creation will be skipped.
+	"""
+
 	help = 'Creates a default superuser'
 
+	def add_arguments(self, parser):
+		parser.add_argument(
+			'--username',
+			type = str,
+			help = 'Specify the superuser username',
+			default = os.getenv('DJANGO_SUPERUSER_USERNAME', 'admin')
+		)
+		parser.add_argument(
+			'--email',
+			type=str,
+			help='Specify the superuser email',
+			default=os.getenv('DJANGO_SUPERUSER_EMAIL', 'admin@email.invalid')
+		)
+		parser.add_argument(
+			'--password',
+			type=str,
+			help='Specify the superuser password',
+			default=os.getenv('DJANGO_SUPERUSER_PASSWORD', 'gradecheck')
+		)
+
 	def handle(self, *args, **options):
-		User = get_user_model()
-		if User.objects.exists():
-			self.stdout.write(self.style.WARNING('Users already exist - skipping default user creation'))
+		user_model = get_user_model()
+		style = color_style()
+
+		if user_model.objects.exists():
+			self.stdout.write(style.SUCCESS('Skipping default user creation')) # pylint: disable=no-member
 			return
-		User.objects.create_superuser(
-			username='admin',
-			email='admin@email.invalid',
-			password='gradecheck'
-		)
-		self.stdout.write(self.style.SUCCESS('Default superuser created'))
+
+		username = options['username']
+		email = options['email']
+		password = options['password']
+
+		try:
+			user_model.objects.create_superuser(username=username, email=email, password=password)
+			self.stdout.write(style.SUCCESS(f'Default superuser "{username}" created')) # pylint: disable=no-member
+		except Exception as e:
+			raise CommandError(f'Failed to create superuser: {e}') from e

core/urls.py

@@ -8,6 +8,14 @@
 	path('login/', auth_views.LoginView.as_view(template_name='login.html'), name='login'),
 	path('logout/', auth_views.LogoutView.as_view(), name='logout'),
 	path('profile/', views.profile_view, name='profile'),
-	path('password_change/', auth_views.PasswordChangeView.as_view(template_name='password_change.html'), name='password_change'),
-	path('password_change/done/', auth_views.PasswordChangeDoneView.as_view(template_name='password_change_done.html'), name='password_change_done'),
+	path(
+		'password_change/',
+		auth_views.PasswordChangeView.as_view(template_name='password_change.html'),
+		name='password_change'
+	),
+	path(
+		'password_change/done/',
+		auth_views.PasswordChangeDoneView.as_view(template_name='password_change_done.html'),
+		name='password_change_done'
+	),
 ]

docs/enviornment-variables.md

@@ -0,0 +1,47 @@
+# Environment variables
+
+## Spreadsheet
+
+- `SPREADSHEET_ID`
+	- The ID of the spreadsheet you want to share
+	- You can extract it from the URL
+	- Example value: `1tAD7xkj3GdSL1xnRlA4UJXCKO_71pzwiVKY8Fkr-XY4`
+- `SHEET_NAME`
+	- The name of the page you want to share
+	- Located at the bottom of the spreadsheet
+	- Example value: `Sheet1`
+- `CACHE_TIMEOUT`
+	- Time in seconds before the sheet cache expires
+	- Caching is done to reduce the amount of requests to the API
+	- Example value: `300` (5 minutes)
+
+## Django
+
+- `DJANGO_SECRET_KEY`
+	- Secret key used for cryptographic signing
+	- Default value: generated automatically when the app is run for the first time
+	- Example value: `uWZOXv1Tl10ZXpxEUe-xPB10RlYz05YRTpjpvnQQHqTGOg2C5TZxvuEiKKOphYbJUHs`
+
+## Postgres
+
+- `POSTGRES_DB`
+	- Name for the postgres database
+	- Example value: `gcdb`
+- `POSTGRES_USER`
+	- Username for the postgres user
+	- Example value: `gcuser`
+- `POSTGRES_PASSWORD`
+	- Password for the postgres user
+	- Example value: `gcpass`
+- `POSTGRES_HOST`
+	- Host address for the postgres database
+	- Default value: `localhost`
+
+## Default admin
+
+- `DEFAULT_ADMIN_USERNAME`
+	- Username for the initial admin user
+	- Default value: `admin`
+- `DEFAULT_ADMIN_PASSWORD`
+	- Password for the initial admin user
+	- Default value: `gradecheck`

requirements.txt

@@ -5,5 +5,4 @@ google-auth-oauthlib
 gunicorn
 psycopg2-binary
 pylint
-python-decouple
 python-dotenv

sheets/utils.py

@@ -1,21 +1,19 @@
 import os
-import pickle
-from datetime import datetime, timedelta
+
 from django.core.cache import cache
-from decouple import config
 
 from google.oauth2.service_account import Credentials
 from googleapiclient.discovery import build
 
-SPREADSHEET_ID = config('SPREADSHEET_ID')
-SHEET_NAME = config('SHEET_NAME')
+SPREADSHEET_ID = os.getenv("SPREADSHEET_ID")
+SHEET_NAME = os.getenv("SHEET_NAME")
 RANGE_NAME = SHEET_NAME
 
 SCOPES = ['https://www.googleapis.com/auth/spreadsheets.readonly']
 SERVICE_ACCOUNT_FILE = os.path.join(os.path.dirname(__file__), '..', 'credentials.json')
 
 CACHE_KEY = 'google_sheet_data'
-CACHE_TIMEOUT = float(config('CACHE_TIMEOUT'))
+CACHE_TIMEOUT = float(os.getenv("CACHE_TIMEOUT"))
 
 
 def get_sheet_service():