added comments

QuizSystem/settings.py

@@ -52,6 +52,7 @@ MIDDLEWARE = [
 
 ROOT_URLCONF = 'QuizSystem.urls'
 
+""" Added path to templates directory"""
 TEMPLATES = [
     {	
         'BACKEND': 'django.template.backends.django.DjangoTemplates',
@@ -73,7 +74,7 @@ WSGI_APPLICATION = 'QuizSystem.wsgi.application'
 
 # Database
 # https://docs.djangoproject.com/en/2.2/ref/settings/#databases
-
+"""Added path to database"""
 DATABASES = {
     'default': {
         'ENGINE': 'django.db.backends.sqlite3',

QuizSystem/urls.py

@@ -23,7 +23,7 @@ from django.views.generic import TemplateView
 from django.conf.urls.static import static
 from django.urls import path,include
 from django.contrib.auth import views as auth_views
-
+"""Defined all url patterns to access various pages of the application"""
 urlpatterns = [
     path('admin/', admin.site.urls),
             path('',a.student,name="student"),

quiz/admin.py

@@ -8,6 +8,7 @@ from .models import quiz
 from .models import result
 from .models import Permission
 from .models import log
+""""To easily insert and update data for the various models thorough django admin page"""
 admin.site.register(Questions)
 admin.site.register(submission)
 admin.site.register(cribs)

quiz/forms.py

 from django import forms
 
 class UploadFileForm(forms.Form):
+    """To create the form for uploading the quiz in CSV form by the instructor"""
     file = forms.FileField()
\ No newline at end of file

quiz/models.py

@@ -4,12 +4,13 @@ import datetime
 from django.utils import timezone
 
 class Permission(models.Model):
+    """Defines the permission of the user default permission is Student the admin can provide staff permission"""
     userId=models.ForeignKey(to=User, on_delete=models.CASCADE)
     role=models.CharField(max_length=1,default="S")
 
 class quiz(models.Model):
+    """Contains information about the quiz time,length,code and instructor who has created it"""
     quizId=models.AutoField(primary_key=True) #primary key
-    #startTime=models.DateTimeField(auto_now_add=True,default=datetime.datetime.now) 
     startTime=models.TimeField()
     date=models.DateField(default=datetime.date.today)
     length=models.FloatField(max_length=10)
@@ -28,6 +29,7 @@ class quiz(models.Model):
         return str(self.quizId)
 
 class Questions(models.Model):
+    """ Contains info about the questions within a particular quiz and its attributes like socre and negative marks and correct answer"""
     question = models.TextField()
     option1 = models.CharField(max_length=100)
     option2 = models.CharField(max_length=100)
@@ -48,7 +50,7 @@ class Questions(models.Model):
         db_table="Questions"
 
 class submission(models.Model):
-    
+    """ Contains info about each questions answer submitted by each student"""
     questionId=models.ForeignKey(Questions,to_field='questionId',on_delete=models.CASCADE)
     option=models.CharField(max_length=100)
     studentId=models.ForeignKey(to=User, on_delete=models.CASCADE)
@@ -56,6 +58,7 @@ class submission(models.Model):
 
 
 class cribs(models.Model):
+    """ Contains cribs raised by students"""
     studentId=models.ForeignKey(to=User, on_delete=models.CASCADE)
     cribs=models.CharField(max_length=1000)
     quizId=models.ForeignKey(quiz,to_field='quizId',on_delete=models.CASCADE)
@@ -65,12 +68,14 @@ class cribs(models.Model):
 
 
 class result(models.Model):
+    """Stores cumulative score by each student in each quiz"""
     studentId = models.ForeignKey(to=User, on_delete=models.CASCADE)
     quizId = models.ForeignKey(quiz, to_field='quizId', on_delete=models.CASCADE)
     marks=models.IntegerField(default=0)
 
 
 class log(models.Model):
+    """stores the student activity information for monitoring the students"""
     quizId=models.ForeignKey(quiz,to_field='quizId',on_delete=models.CASCADE, default="")
     studentId = models.ForeignKey(to=User, on_delete=models.CASCADE, default="")
     logtime = models.DateTimeField(default=timezone.now)