Reordering Questions: Admin functionality (#17)

* updated requirements.txt for sortable objects

* feat: admin can now sort questions

* updated README for prod config + removed backports dependency

Author: Sanvit-Katrekar

.gitignore

@@ -4,4 +4,4 @@ secret.key
 .venv
 .env
 venv
-.env
+.env

README.md

@@ -46,9 +46,9 @@ Replace:
 * Create a new file ```.env``` and add in the secrets needed
 
     ```bash
-    CLIENT_ID = XXX.apps.googleusercontent.com
+    CLIENT_ID=XXX.apps.googleusercontent.com
     CLIENT_SECRET=XXX-YYY-ZZZ
-    SECRET_KEY = XXX
+    SECRET_KEY=XXX
     ```
 
 ## Usage
@@ -69,3 +69,77 @@ python manage.py runserver 0.0.0.0:8000
 *   A leaderboard showcasing the `User`s with the most points.
 
     Ties are settled based on the time taken to complete `Task`s
+
+## Configuration for Production
+
+### Adding environment variables for MYSQL
+
+* Update the new file ```.env``` and add in the secrets needed for using MySQL
+
+```bash
+CLIENT_ID=XXX.apps.googleusercontent.com
+CLIENT_SECRET=XXX-YYY-ZZZ
+SECRET_KEY=XXX
+MYSQL_HOST=XXX
+MYSQL_USERNAME=XXX
+MYSQL_DATABASE=‘XXX’
+MYSQL_PASSWORD=XXX
+```
+
+### Change backend to MySQL
+
+In [settings.py](mouseless/settings.py), update the backend from SQLite3 to MySQL.
+
+Change this:
+
+```python
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+```
+To this:
+```python
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.mysql',
+        'NAME': os.getenv('MYSQL_DATABASE'),
+        'USER': os.getenv('MYSQL_USERNAME'),
+        'PASSWORD': os.getenv('MYSQL_PASSWORD'),
+        'HOST': os.getenv('MYSQL_HOST')
+    }
+}
+```
+
+### Updating the static path
+
+In [settings.py](mouseless/settings.py), comment out the `STATIC_DIR` variable and add `STATIC_ROOT` as below:
+```bash
+# STATICFILES_DIRS = (os.path.join(BASE_DIR, "static"),)
+STATIC_ROOT = os.path.join(BASE_DIR, "static")
+```
+Then in the bash console, run the command:
+```
+python manage.py collectstatic
+```
+This will now put all static files into one static folder
+
+Now, add this static folder path into PythonAnywhere's Web section:
+
+| URL   | Directory |
+| -------- | ------- |
+| /static/  | /home/{{USERNAME}}/{{PATH_TO_STATIC_FOLDER}} |
+
+If you're adding the reorder functionality to an already existing db, run the command:
+```bash
+python manage.py reorder quiz.Task
+```
+This will now set the order attr of each record
+
+Then you can migrate the changes:
+```bash
+python manage.py makemigrations
+python manage.py migrate
+```

db.sqlite3

@@ -1,4 +1,7 @@
 import os
+from dotenv import load_dotenv, find_dotenv
+
+load_dotenv(find_dotenv())
 
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
@@ -40,6 +43,7 @@
     'crispy_forms',
     'phonenumber_field',
     'markdownx',
+    'adminsortable2',
     'django.contrib.admin',
     'django.contrib.auth',
     'django.contrib.contenttypes',
@@ -126,6 +130,18 @@
         'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
     }
 }
+# Use below for prod
+"""
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.mysql',
+        'NAME': os.getenv('MYSQL_DATABASE'),
+        'USER': os.getenv('MYSQL_USERNAME'),
+        'PASSWORD': os.getenv('MYSQL_PASSWORD'),
+        'HOST': os.getenv('MYSQL_HOST')
+    }
+}
+"""
 
 
 # Password validation

mouseless/settings.py

@@ -1,9 +1,10 @@
 from django.contrib import admin
 from .models import Task, Card, Answer, Hint
 from markdownx.admin import MarkdownxModelAdmin
+from adminsortable2.admin import SortableAdminMixin
 
 @admin.register(Task)
-class TaskAdmin(MarkdownxModelAdmin):
+class TaskAdmin(SortableAdminMixin, MarkdownxModelAdmin):
     fields = ('name', 'text', 'points', 'correct','hint','hint_points')
     list_display = ('name', 'points', 'correct',)
 

quiz/admin.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2 on 2024-09-01 15:38
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('quiz', '0006_hint'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='task',
+            options={'ordering': ['points']},
+        ),
+    ]

quiz/migrations/0007_alter_task_options.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2 on 2024-09-01 15:52
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('quiz', '0007_alter_task_options'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='task',
+            options={'ordering': ['my_order']},
+        ),
+        migrations.AddField(
+            model_name='task',
+            name='my_order',
+            field=models.PositiveIntegerField(default=0),
+        ),
+    ]

quiz/migrations/0008_alter_task_options_task_my_order.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2 on 2024-09-01 18:25
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('quiz', '0008_alter_task_options_task_my_order'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='task',
+            options={'ordering': ['order']},
+        ),
+        migrations.RenameField(
+            model_name='task',
+            old_name='my_order',
+            new_name='order',
+        ),
+    ]

quiz/migrations/0009_alter_task_options_rename_my_order_task_order.py

@@ -14,6 +14,14 @@ class Task(models.Model):
     correct = models.CharField(max_length=256)
     hint = models.CharField(max_length=256, default='No hint!!')
     hint_points = models.IntegerField(default=0)
+    order = models.PositiveIntegerField(
+        default=0,
+        blank=False,
+        null=False,
+    )
+    
+    class Meta:
+        ordering = ['order']
 
     @property
     def formatted_markdown(self):
@@ -22,7 +30,6 @@ def formatted_markdown(self):
     def get_absolute_url(self):
         return reverse('task-detail', kwargs={'pk': self.pk})
 
-
 class Card(models.Model):
     user = models.OneToOneField(User, null=True, blank=True, on_delete=models.CASCADE)
     start = models.DateTimeField(auto_now_add=True, auto_now=False)
@@ -43,15 +50,13 @@ def last_time(self):
 
         return str(last_time - self.start)
 
-
 class Answer(models.Model):
     card = models.ForeignKey(Card, on_delete=models.CASCADE)
     task = models.ForeignKey(Task, on_delete=models.CASCADE)
     value = models.CharField(max_length=256)
     submit = models.DateTimeField(auto_now=True)
     time_submitted = models.DateTimeField(auto_now=True)
 
-
     class Meta:
         unique_together = (('card', 'task'),)
 

quiz/models.py

@@ -33,7 +33,6 @@ def register(request):
         form = UserRegisterForm()
     return render(request, 'quiz/register.html', {'form': form})
 
-
 class TaskListView(LoginRequiredMixin, UserPassesTestMixin, ListView):
     model = Task
     template_name = 'quiz/task_list.html'
@@ -57,7 +56,7 @@ def get_context_data(self, **kwargs):
         return context
 
     def get_queryset(self):
-        return Task.objects.all().order_by('points')
+        return Task.objects.all().order_by('order', 'points')
 
 
 

quiz/views.py

@@ -7,7 +7,8 @@ charset-normalizer==3.3.2
 cryptography==43.0.0
 defusedxml==0.7.1
 dj-database-url==1.0.0
-Django==4.1
+Django==4.2
+django-admin-sortable2==2.2.2
 django-allauth==0.63.6
 django-cors-headers==4.4.0
 django-crispy-forms==1.14.0
@@ -21,7 +22,6 @@ gunicorn==20.1.0
 idna==3.8
 importlib-metadata==4.12.0
 jwcrypto==1.5.6
-jwt==1.3.1
 Markdown==3.4.1
 oauthlib==3.2.2
 phonenumbers==8.12.54
@@ -36,10 +36,9 @@ pytz==2024.1
 PyYAML==6.0.2
 requests==2.32.3
 requests-oauthlib==2.0.0
-setuptools==73.0.1
 sqlparse==0.4.2
 typing_extensions==4.12.2
 tzdata==2022.2
 urllib3==2.2.2
 whitenoise==5.0.1
-zipp==3.8.1
+zipp==3.8.1