Add core app

.gitignore

@@ -136,3 +136,8 @@ GitHub.sublime-settings
 !.vscode/launch.json 
 !.vscode/extensions.json 
 .history
+
+uploads/
+files/
+logs/
+sandbox.py

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "python.linting.pylintEnabled": true,
+  "python.linting.pylintArgs": [
+    "--load-plugins=pylint_django",
+    "--max-line-length=120",
+    "--disable=django-not-configured",
+    "--django-settings-module=lms.settings"
+  ]
+}

README.md

@@ -8,7 +8,7 @@ You first need an env ☘️
 
 ```python
 # create the env
-conda create --name libraryenv
+conda create --name lms
 
 # install requirements
 pip install -r requirements.txt
@@ -19,6 +19,8 @@ accordingly. Otherwise you just need a .env file with DB credentials.
 Migrate models to your db
 
 ```python
+python manage.py makemigrations
+
 python manage.py migrate
 ```
 
@@ -27,11 +29,3 @@ Start the app
 ```python
 python manage.py runserver
 ```
-
-### Documentation 📝:
-
-Complete docs of the API are available at the endpoint:
-
-```
-http://{HOST}/docs
-```

core/admin.py

@@ -0,0 +1,21 @@
+"""core admin panel"""
+
+from django.contrib import admin
+from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
+
+from core.models import User
+
+
+@admin.register(User)
+class UserAdmin(BaseUserAdmin):
+    """Over ride user view in admin panel"""
+
+    add_fieldsets = (
+        (
+            None,
+            {
+                "classes": ("wide",),
+                "fields": ("username", "email", "password1", "password2"),
+            },
+        ),
+    )

core/apps.py

@@ -0,0 +1,14 @@
+"""Core config of LMS"""
+
+from django.apps import AppConfig
+
+
+class CoreConfig(AppConfig):
+    """This class defines core app configs"""
+
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "core"
+
+    def ready(self) -> None:
+        """Sets up imports and pre-requisites for this app"""
+        import core.signals

core/cron.py

@@ -0,0 +1,28 @@
+""" This module has all core app corn jobs"""
+
+from datetime import datetime
+import logging
+
+from templated_mail.mail import BaseEmailMessage
+
+from core.models import BookLoan
+
+
+logger = logging.getLogger(__name__)
+
+
+def email_overdue_books():
+    """cron job for emailing user which have a book overdue"""
+    today = datetime.now()
+    loan_queryset = BookLoan.objects.select_related('book', 'user').filter(date_due__lt=today)
+
+    for loan in loan_queryset:
+        message = BaseEmailMessage(
+            template_name="emails/overdue_books.html",
+            context={
+                "name": loan.user,
+                "book": loan.book,
+            },
+        )
+        message.send([loan.user.email])
+        logger.info("email sent to %s for %s due: %s", loan.user.email, loan.book, loan.date_due)

core/management/commands/import_books_from_csv.py

@@ -0,0 +1,45 @@
+import csv
+from typing import Any, Optional
+
+from django.core.management.base import BaseCommand, CommandParser
+
+from core.serializers import BookSerializer
+from core.models import Book
+
+
+class Command(BaseCommand):
+    help = "Import books form csv"
+
+    def add_arguments(self, parser: CommandParser) -> None:
+        parser.add_argument("file_path", nargs=1, type=str)
+
+    def handle(self, *args: Any, **options: Any) -> Optional[str]:
+        self.file_path = options['file_path'][0]
+        self.prepare()
+        self.main()
+        self.finalize()
+
+    def prepare(self):
+        self.imported_counter = 0
+        self.skipped_counter = 0
+
+    def main(self):
+        self.stdout.write("=== Importing Books ===\n\n")
+
+        with open(self.file_path, 'r') as f:
+            reader = csv.DictReader(f)
+
+            for index, row in enumerate(reader):
+                serializer = BookSerializer(data=row)
+                if serializer.is_valid():
+                    self.imported_counter += 1
+                    serializer.save()
+                    self.stdout.write(f'{index} {row["name"]} SAVED')
+                else:
+                    self.skipped_counter += 1
+                    self.stdout.write(f'{index} {row["name"]} SKIPPED {serializer.errors}')
+
+    def finalize(self):
+        self.stdout.write("----------------------")
+        self.stdout.write(f"Books imported: {self.imported_counter}")
+        self.stdout.write(f"Books skipped: {self.skipped_counter}")