Teacher Modules

​

Overview

​

Core Module

​

TeacherRegCore

• Admin Title: “Core Teacher Registration”
• Link Title: “Teacher Registration”
• Module Type: “teach”
• Seq: -9999 (displayed first)
• Choosable: Yes

• Displays all enabled teacher modules as steps
• Enforces required module completion
• Shows progress indicators
• Links to class management

• teacherreg - Main registration page showing all steps

​

Required Modules

​

RegProfileModule

• Admin Title: “Teacher Profile Editor”
• Link Title: “Update Your Profile”
• Module Type: “teach”
• Required: Yes
• Seq: 0 (first step)

• Contact information editing
• Teaching experience
• Availability for programs

• teacher_profile: Teachers who have filled out a profile

​

TeacherBioModule

• Admin Title: “Teacher Biography Editor”
• Link Title: “Update your teacher biography”
• Module Type: “teach”
• Seq: -111
• Choosable: Yes

• Rich text biography editor
• Biography appears in class catalog
• Per-program customization
• URL slug generation

• teacher_biographies: Teachers who have completed their biography

​

TeacherAcknowledgementModule

• Admin Title: “Teacher Acknowledgement”
• Link Title: “Teacher Acknowledgement”
• Module Type: “teach”
• Choosable: No (must be manually added)

• Customizable agreement text
• Checkbox confirmation required
• Records acknowledgement

​

Class Management Modules

​

TeacherClassRegModule

• Admin Title: “Teacher Class Registration”
• Link Title: “Register Your Classes”
• Module Type: “teach”
• Seq: 10
• Inline Template: “listclasses.html”
• Choosable: Yes

• Create new classes
• Edit existing classes
• Manage multiple sections
• Set class capacity, grades, prerequisites
• Request resources (projectors, whiteboards, etc.)
• Add/remove co-teachers
• View enrolled students
• Cancel classes or request cancellation
• Application question setup
• Open class registration

• listclasses - Inline list of teacher’s classes
• makeaclass - Create a new class
• editclass - Edit an existing class
• manageclass - Detailed class management interface
• addsection - Add a section to a class
• delsection - Remove a section
• teacherlookup - Search for co-teachers
• cancelclass - Cancel a class or section
• reviewstudentapps - Review student applications
• survey_results - View class surveys

• allow_coteach: Enable co-teaching
• set_prereqs: Allow prerequisite specification
• class_max_duration: Maximum class length in minutes
• class_min_cap, class_max_size: Class size constraints
• allowed_sections: Number of sections allowed
• num_teacher_questions: Max application questions
• color_code: Custom color for classes
• allow_lateness: Allow students to arrive late
• ask_for_room: Request specific rooms
• open_class_registration: Enable open class option

• class_submitted: Teachers with at least one class
• class_approved: Teachers with approved classes
• class_rejected: Teachers with rejected classes

​

TeacherModeratorModule

• Admin Title: “Teacher Moderator Registration”
• Link Title: “Moderate Classes”
• Module Type: “teach”
• Choosable: Yes

• Browse classes needing moderators
• Sign up to moderate
• View moderation schedule

​

Availability and Scheduling

​

AvailabilityModule

• Admin Title: “Teacher Availability”
• Link Title: “Indicate Your Availability”
• Module Type: “teach”
• Seq: 0
• Choosable: Yes

• Calendar interface to select available times
• Required before class registration
• Helps with automated scheduling
• Can import from other programs

• availability - Set availability
• availability_post - Save availability

• availability_available: Teachers who completed availability

​

TeacherEventsModule

• Admin Title: “Teacher Event Sign-up”
• Link Title: “Sign Up for Teacher Events”
• Module Type: “teach”
• Choosable: Yes

• Register for teacher training sessions
• Sign up for interviews
• Capacity management

​

Class Preview and Applications

​

TeacherPreviewModule

• Admin Title: “Teacher Class Preview”
• Link Title: “Preview Your Classes”
• Module Type: “teach”
• Choosable: Yes

• See catalog view of classes
• Preview before approval
• Check formatting and display

​

TeacherReviewApps

• Admin Title: “Teacher Review Applications”
• Link Title: “Review Student Applications”
• Module Type: “teach”
• Choosable: Yes

• View student applications
• Approve/reject students
• Leave comments
• Email applicants

​

Quiz and Assessment

​

TeacherQuizModule

• Admin Title: “Teacher Quiz”
• Link Title: “Teacher Training Quiz”
• Module Type: “teach”
• Required: Yes (configurable)
• Choosable: Yes

• Multiple choice questions
• Required passing score
• Blocks class registration until passed
• Retake capability

• quiz_done: Teachers who passed the quiz

​

Onsite Teacher Modules

​

TeacherOnsite

• Admin Title: “Teacher Onsite”
• Link Title: “Onsite Info”
• Module Type: “teach”
• Choosable: Yes

​

TeacherCheckinModule

• Admin Title: “Teacher Check-In”
• Link Title: “Check in teachers”
• Module Type: “onsite”
• Seq: 10
• Choosable: Yes

• Barcode scanning
• Manual search and check-in
• Attendance tracking
• Class roster access

​

Communication and Display

​

TeacherBigBoardModule

• Admin Title: “Teacher Big Board”
• Link Title: “Teacher Big Board”
• Module Type: “teach”
• Choosable: Yes

• Large display of teaching schedule
• Room assignments
• Real-time updates
• Suitable for projection

​

Survey Modules

​

TeacherSurveyModule

• Admin Title: “Teacher Survey”
• Link Title: “Teacher Survey”
• Module Type: “teach”
• Choosable: No

​

Custom Form Modules

​

TeacherCustomFormModule

• Admin Title: “Teacher Custom Form”
• Link Title: “Custom Form”
• Module Type: “teach”
• Choosable: Yes

• Configurable form fields
• Custom validation
• Data export

​

Development Notes

​

Creating a Custom Teacher Module

1. Create a new file in esp/esp/program/modules/handlers/
2. Inherit from ProgramModuleObj
3. Set module_type = "teach"
4. Implement required methods:

from esp.program.modules.base import ProgramModuleObj, needs_teacher, main_call

class MyTeacherModule(ProgramModuleObj):
    doc = """Description of module purpose."""
    
    @classmethod
    def module_properties(cls):
        return {
            "admin_title": "My Teacher Module",
            "link_title": "My Module",
            "module_type": "teach",
            "seq": 50,
            "choosable": 1,
        }
    
    @main_call
    @needs_teacher
    @meets_deadline('/MyDeadline')
    def myview(self, request, tl, one, two, module, extra, prog):
        # Implementation
        pass

​

Common Teacher Module Patterns

​

Tracking Teachers Who Completed a Task

def teachers(self, QObject=False):
    q = Q(teacherbio__program=self.program)
    if QObject:
        return {'teacher_biographies': q}
    return {'teacher_biographies': ESPUser.objects.filter(q).distinct()}

def teacherDesc(self):
    return {'teacher_biographies': "Teachers who completed their bio"}

​

Checking Module Completion

def isCompleted(self):
    user = get_current_request().user
    # Check if teacher completed the required task
    return TeacherBio.objects.filter(
        user=user,
        program=self.program
    ).exists()

​

Integration with Class Management

def prepare(self, context):
    """Add data to teacher registration page."""
    user = get_current_request().user
    context['teacher_classes'] = user.getTaughtClasses(self.program)
    context['can_edit'] = self.deadline_met('/Classes/Edit')
    return context

​

See Also

• Program Modules Overview
• Student Modules
• Admin Modules
• Onsite Modules