🎨 feat: Update course models

apps/courses/constants/defaults.py

@@ -0,0 +1,3 @@
+HTK_APPS_COURSES_MODELS_COURSE = 'htk.course'
+HTK_APPS_COURSES_MODELS_CHAPTER = 'htk.chapter'
+HTK_APPS_COURSES_MODELS_LESSON = 'htk.lesson'

apps/courses/models/__init__.py

@@ -0,0 +1,11 @@
+# HTK Imports
+from htk.apps.courses.models.chapter import Chapter
+from htk.apps.courses.models.course import Course
+from htk.apps.courses.models.lesson import Lesson
+
+
+__all__ = [
+    'Chapter',
+    'Course',
+    'Lesson',
+]

apps/courses/models/assessment.py

@@ -0,0 +1,8 @@
+# HTK Imports
+from htk.models.classes import HtkBaseModel
+
+
+class Assessment(HtkBaseModel):
+    """Assessments are quizzes, exams, etc"""
+
+    pass

apps/courses/models/chapter.py

@@ -0,0 +1,28 @@
+# Django Imports
+from django.db import models
+
+# HTK Imports
+from htk.apps.courses.models.fk_fields import fk_course
+from htk.models.classes import HtkBaseModel
+
+
+DEFAULT_RELATED_NAME = 'chapters'
+
+
+class Chapter(HtkBaseModel):
+    """Chapters are an optional grouping for lessons within a course.
+
+    Chapters are analogous to "Acts" in creative works such as films, plays, and novels.
+
+    Courses that are larger might be organized into separate Chapters
+
+    Alternate names considered:
+    - CourseModule
+    - CourseSection
+    """
+
+    name = models.CharField(max_length=256)
+    order = models.PositiveIntegerField(default=0)
+
+    # Relations
+    course = fk_course(DEFAULT_RELATED_NAME, required=True)

apps/courses/models/course.py

@@ -0,0 +1,11 @@
+# Django Imports
+from django.db import models
+
+# HTK Imports
+from htk.models.classes import HtkBaseModel
+
+
+class Course(HtkBaseModel):
+    """Courses are the root object for a course"""
+
+    name = models.CharField(max_length=256)

apps/courses/models/fk_fields.py

@@ -0,0 +1,24 @@
+# Django Imports
+from django.db import models
+
+# HTK Imports
+from htk.models.fk_fields import build_kwargs
+from htk.utils import htk_setting
+
+
+def fk_course(related_name: str, required: bool = False) -> models.ForeignKey:
+    field = models.ForeignKey(
+        htk_setting('HTK_APPS_COURSES_MODELS_COURSE'),
+        related_name=related_name,
+        **build_kwargs(required=required),
+    )
+    return field
+
+
+def fk_chapter(related_name: str, required: bool = False) -> models.ForeignKey:
+    field = models.ForeignKey(
+        htk_setting('HTK_APPS_COURSES_MODELS_CHAPTER'),
+        related_name=related_name,
+        **build_kwargs(required=required),
+    )
+    return field

apps/courses/models/lesson.py

@@ -0,0 +1,27 @@
+# Django Imports
+from django.db import models
+
+# HTK Imports
+from htk.apps.courses.models.fk_fields import (
+    fk_chapter,
+    fk_course,
+)
+from htk.models.classes import HtkBaseModel
+
+
+DEFAULT_RELATED_NAME = 'lessons'
+
+
+class Lesson(HtkBaseModel):
+    """Lessons are the main component within the Courses app
+    that hold the bulk of the content.
+
+    Naturally, a Course is a collection of many Lessons.
+    """
+
+    name = models.CharField(max_length=256)
+    order = models.PositiveIntegerField(default=0)
+
+    # Relations
+    course = fk_course(DEFAULT_RELATED_NAME, required=True)
+    chapter = fk_chapter(DEFAULT_RELATED_NAME, required=False)

constants/defaults.py

@@ -92,6 +92,7 @@
 from htk.apps.accounts.constants.defaults import *
 from htk.apps.bible.constants.defaults import *
 from htk.apps.changelog.constants.defaults import *
+from htk.apps.courses.constants.defaults import *
 from htk.apps.cpq.constants.defaults import *
 from htk.apps.file_storage.constants.defaults import *
 from htk.apps.geolocations.constants.defaults import *