Update of Documentation improvement.

Appropriate comment lines for easy understanding of the code.

Author: tamaraiselvan

Base_Master/settings.py

@@ -15,13 +15,13 @@
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
 BASE_DIR = Path(__file__).resolve().parent.parent
 
-
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/4.0/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
 SECRET_KEY = 'django-insecure-k6k-x^q$jjp*@bs#_7yw-!&cyn4g^byvr*lseiok=h=t#!)bw4'
 ENCRYPT_KEY = b'Py6zhVP-eFxkfq0kHUN0ZmIePwwaOeQ12ZmrFAVLbI8='
+
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
@@ -31,7 +31,7 @@
 # Application definition
 
 INSTALLED_APPS = [
-    'jazzmin',
+    'jazzmin', #Package used to customize the Django Admin Panel
     'django.contrib.admin',
     'django.contrib.auth',
     'django.contrib.contenttypes',
@@ -45,7 +45,7 @@
     'import_export',
     'django_cleanup.apps.CleanupConfig',
 ]
-IMPORT_EXPORT_USE_TRANSACTIONS = True
+IMPORT_EXPORT_USE_TRANSACTIONS = True #Mandatory for Transactions perfomred with import_export package
 CRISPY_TEMPLATE_PACK = 'bootstrap4'
 
 MIDDLEWARE = [
@@ -126,6 +126,8 @@
 
 STATIC_URL = 'static/'
 STATICFILES_DIRS = [BASE_DIR / 'static']
+
+# Media Files (Images, Files...), This files are stored with associate with databse
 MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
 MEDIA_URL = '/media/'
 
@@ -134,13 +136,14 @@
 
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
 
+###### Message Rendering tags ######
 from django.contrib.messages import constants as messages
 MESSAGE_TAGS = {
-        messages.DEBUG: 'alert-secondary',
-        messages.INFO: 'alert-info',
-        messages.SUCCESS: 'alert-success',
-        messages.WARNING: 'alert-warning',
-        messages.ERROR: 'alert-danger',
+    messages.DEBUG: 'alert-secondary',
+    messages.INFO: 'alert-info',
+    messages.SUCCESS: 'alert-success',
+    messages.WARNING: 'alert-warning',
+    messages.ERROR: 'alert-danger',
 }
 
 #### Email Intergration ###
@@ -151,8 +154,8 @@
 EMAIL_HOST_PASSWORD = 'password' #You should type your Email password
 EMAIL_USE_TLS = True
 
-LOGIN_REDIRECT_URL = 'home'
-LOGOUT_REDIRECT_URL = 'login'
+LOGIN_REDIRECT_URL = 'home' #this Url is used to redirect Users after login
+LOGOUT_REDIRECT_URL = 'login' #this Url is used to redirect Users after logout
 
 ######################  ADMIN DASHBOARD OVERWRITE  ######################
 JAZZMIN_SETTINGS = {

Base_Master/urls.py

@@ -1,5 +1,5 @@
 from django.contrib import admin
-from django.urls import path,include, re_path
+from django.urls import path,include
 from django.contrib.auth.views import LoginView
 from firstapp import views
 from django.conf import settings

README.md

@@ -29,7 +29,8 @@ Project is created with:
 7. Theme Customizer.<br>
 8. Bulk Import & Export data.<br>
 9. Automation in creating profile.<br>
-10. Automatically Delete profile photos which are unused.
+10. Automatically Delete files/images from media which are unused.<br>
+11. Highly documented with appropriate comment lines for easy understading of the code.
 
 ## Setup
 

firstapp/admin.py

@@ -8,4 +8,8 @@
 admin.site.unregister(Group)
 admin.site.register(Group, ImportExportModelAdmin)
 admin.site.register(Theme)
-admin.site.register(Profile)
+admin.site.register(Profile)
+
+# Add import export model mixin to the model while registering the model in admin.py
+# Example:
+# admin.site.register(Theme, ImportExportModelAdmin)

firstapp/apps.py

@@ -4,5 +4,7 @@
 class FirstappConfig(AppConfig):
     default_auto_field = 'django.db.models.BigAutoField'
     name = 'firstapp'
+
+    # This signal is integrated in this app
     def ready(self):
         import firstapp.signals

firstapp/forms.py

@@ -3,6 +3,7 @@
 from django.contrib.auth.models import User
 from firstapp.models import Profile
 
+### This is the Sign Up Form
 class SignUpForm(UserCreationForm):
     first_name = forms.CharField(widget=forms.TextInput(attrs={'class':'form-control', 'placeholder': 'Enter First name'}), required=True)
     last_name = forms.CharField(widget=forms.TextInput(attrs={'class':'form-control', 'placeholder': 'Enter last name'}), required=True)
@@ -14,13 +15,15 @@ class Meta:
         model = User
         fields = ('username', 'first_name', 'last_name', 'email', 'password1', 'password2', )
 
+    ### This is used to check if the registering email is exists in the database or not.
     def clean_email(self):
         email = self.cleaned_data.get("email")
         user_count = User.objects.filter(email=email).count()
         if user_count > 0:
             raise forms.ValidationError("This email is already exists.")
         return email
 
+### This is the User editing form        
 class User_edit(forms.ModelForm):
     first_name = forms.CharField(widget=forms.TextInput(attrs={'class':'form-control', 'placeholder': 'Enter First name'}), required=True)
     last_name = forms.CharField(widget=forms.TextInput(attrs={'class':'form-control', 'placeholder': 'Enter last name'}), required=True)
@@ -29,6 +32,7 @@ class Meta:
         model = User
         fields=['email','first_name','last_name',]
 
+### This is the Profile editing form
 class profile_edit(forms.ModelForm):
     profile_img = forms.ImageField(widget=forms.FileInput(attrs={'class':'form-control', 'onchange':'preview()','id':'formFile'}))
 

firstapp/models.py

@@ -1,6 +1,8 @@
 from django.db import models
 from django.contrib.auth.models import User
 # Create your models here.
+
+## These are the options for the colors in Theme model.
 themes = (
     ("dark", "dark"),
     ("light", "light"),

firstapp/signals.py

@@ -3,12 +3,13 @@
 from django.dispatch import receiver
 from .models import Profile
 
+### This signal used to create the Profile once the users gets added into the User table
 @receiver(post_save, sender=User)
 def create_profile(sender, instance, created, **kwargs):
     if created:
         Profile.objects.create(user=instance)
 
-
+### The profile created will be saved to the database.
 @receiver(post_save, sender=User)
 def save_profile(sender, instance, **kwargs):
     instance.profile.save()

firstapp/views.py

@@ -5,12 +5,15 @@
 from firstapp.models import Theme
 from django.contrib.admin.models import LogEntry
 # Create your views here.
+
+## Home page view
 @login_required
 def home(request):
     theme = theme_custom(request)
-    logs = LogEntry.objects.filter(user_id=request.user.id)
+    logs = LogEntry.objects.filter(user_id=request.user.id) ## This retrives the Log entry of the User
     return render(request, 'home.html', {'color':theme,'log':logs,})
 
+### User Registration view
 from .forms import SignUpForm, User_edit, profile_edit
 def signup_view(request):
     if request.method == 'POST':
@@ -26,19 +29,21 @@ def signup_view(request):
         form = SignUpForm()
     return render(request, 'registration/registration.html', {'form': form})
 
+### user Profile view
+from firstapp.encryption_util import *
 @login_required
 def profile(request):
     theme = theme_custom(request)
     lst = User.objects.filter(username=request.user).values('id')
     l=[]
-    for i in lst:
+    for i in lst: ## This will encrypt the Url for each User, So that the sensitive information is secure
         i['encrypt_key']=encrypt(i['id'])
         i['id']=i['id']
         l.append(i)
     return render(request, 'profile/profile.html', {'lst':l,'color':theme,})
 
+# Profile Update view
 from django.shortcuts import redirect, render, get_object_or_404
-from firstapp.encryption_util import *
 @login_required
 def profile_update(request):
     theme = theme_custom(request)
@@ -61,7 +66,7 @@ def profile_update(request):
     }
     return render(request, 'profile/edit_profile.html', context)
 
-
+### Disable User view
 from django.contrib.auth import logout
 @login_required
 def disable_user(request, id):

static/dashboard/style.js

@@ -1,3 +1,4 @@
+// This is the first bar grpah chart
 const BarGraph = document.getElementById("BarGraphChart");
 new Chart(BarGraph, {
   type: "bar",
@@ -20,6 +21,7 @@ new Chart(BarGraph, {
   }
 });
 
+// This is the Line graph chart
 const LineGraph = document.getElementById("LineGraphChart");
 new Chart(LineGraph, {
   type: "line",
@@ -55,14 +57,17 @@ new Chart(LineGraph, {
   }
 });
 
-
+// This line of code used to enable tooltips in Bootstrap
 const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]')
 const tooltipList = [...tooltipTriggerList].map(tooltipTriggerEl => new bootstrap.Tooltip(tooltipTriggerEl))
 
+
+// These two functions are used to show preview of the image uploaded in image feild
 function preview() {
   frame.src = URL.createObjectURL(event.target.files[0]);
 }
 
+// This founction refresh the preview if the image is changed in the image feild
 function clearImage() {
   document.getElementById('formFile').value = null;
   frame.src = "";