🎓 School Management
Academic, school finance, library, and student/parent portal for education institutions.
What's in this scope
The School Management scope groups 4 HMX modules that together deliver end-to-end functionality for this area. Each module below focuses on a specific capability — click any card to jump to its documentation.
This scope comprises 4 Django apps under hmx/module/basic/, defining 31 models, 2 API endpoints, and 118 views collectively. Modules share dependencies and can be installed independently. External dependencies: base, core_accounting, core_invoicing, webx.
CS
Core_School
Core_School Description
CS
Core_School_Invoicing
Core_School_Invoicing Description
CS
Core_School_Library
Core_School Description
CS
Core_School_Portal
Core_School_Portal Description
Scope Statistics
📦
4
Modules in scope
🗃️
31
Data models
🔌
2
API endpoints
🖥️
118
UI views
📂
0
Menu items
⚡
55
Actions
Module Relationships
core_school
↔core_school_invoicing
↔core_school_library
↔core_school_portal
Modules within the School Management scope — often used together and share data models.
Getting Started
Install, configure, and enable the School Management scope in your HMX instance.
Prerequisites
- Module
basemust be installed - Module
core_accountingmust be installed - Module
core_invoicingmust be installed - Module
webxmust be installed
Installation Steps
Step 1: Install core_school
Core_School Description
hmx update install core_school --alias=default --noinput
Step 2: Install core_school_invoicing
Core_School_Invoicing Description
hmx update install core_school_invoicing --alias=default --noinput
Step 3: Install core_school_library
Core_School Description
hmx update install core_school_library --alias=default --noinput
Step 4: Install core_school_portal
Core_School_Portal Description
hmx update install core_school_portal --alias=default --noinput
Post-install Checks
💡After installing, verify each module appears in
hmx list-modules and check that their menus are reachable from the HMX UI navigation.Core_School
Core_School Description
Overview
Core_School Description
💡Technical identifier:
core_school. See the Technical mode toggle at the top for full data model and API reference.Module Information
📦
Name
Core_School
🏷️
Version
1.0.0
📂
Category
School
🔗
Depends
3 modules
Dependencies
basecore_accountingwebx
Data Models 23
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| academictracking | AcademicTracking | new | 6 | academic_tracking.py |
| academictrackingattendance | AcademicTrackingAttendance | new | 6 | academic_tracking_attendance.py |
| basecompany | BaseCompany | extends basecompany | 3 | base_company.py |
| user | BaseUsers | extends user | 4 | base_users.py |
| extracurricular | Extracurricular | new | 15 | extracurricular.py |
| extracurricularregistration | ExtracurricularRegistration | new | 6 | extracurricular.py |
| extracurricularbatch | ExtracurricularBatch | new | 4 | extracurricular.py |
| lesson_plan | LessonPlan | new | 5 | extracurricular.py |
| extracurricularscoring | ExtracurricularScoring | new | 8 | extracurricular.py |
| extracurricularscoringline | ExtracurricularScoringLine | new | 10 | extracurricular.py |
| grade | Grade | new | 3 | grade.py |
| gradeline | GradeLine | new | 8 | grade.py |
| school_scoring | SchoolScoring | new | 15 | school_scoring.py |
| school_scoring_exam | SchoolScoringExam | new | 7 | school_scoring.py |
| school_scoring_daily_assignment | SchoolScoringDailyAssignment | new | 6 | school_scoring.py |
| schoolsetting | SchoolSetting | new | 7 | school_setting.py |
| school_subject_weightage | SchoolSubjectWeightage | new | 8 | school_subject_weightage.py |
| school_subject_weightage_exam | SchoolSubjectWeightageExam | new | 3 | school_subject_weightage.py |
| school_subject_weightage_daily_assignment | SchoolSubjectWeightageDailyAssignment | new | 3 | school_subject_weightage.py |
| activity_result | ActivityResult | new | 4 | school_wellbeing_activities.py |
| schoolsession | Session | new | 24 | session.py |
| subject | Subject | new | 4 | subject.py |
| user | User | extends user | 2 | user.py |
academictracking — key fields
| Field | Type |
|---|---|
| student | ForeignKey |
| total_credit | FloatField |
| school | ForeignKey |
| branch | ForeignKey |
| institution | ForeignKey |
| gpa | FloatField |
academictrackingattendance — key fields
| Field | Type |
|---|---|
| academic_tracking | ForeignKey |
| academic_year | ForeignKey |
| term | ForeignKey |
| present | IntegerField |
| partially_present | IntegerField |
| absent | IntegerField |
BaseCompany — key fields
| Field | Type |
|---|---|
| use_formal_school | BooleanField |
| use_university | BooleanField |
| use_course_training | BooleanField |
Security & Access
ACL rules: 273 Groups: 7
School AdminSchool TeacherSchool StaffSchool StudentSchool ParentSchool CounselorSchool Manager
Core_School_Invoicing
Core_School_Invoicing Description
Overview
Core_School_Invoicing Description
💡Technical identifier:
core_school_invoicing. See the Technical mode toggle at the top for full data model and API reference.Module Information
📦
Name
Core_School_Invoicing
🏷️
Version
1.0.0
📂
Category
Core_School_Invoicing Category
🔗
Depends
4 modules
Dependencies
basecore_invoicingcore_schoolcore_accounting
Data Models 2
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| accountdocument | AccountDocument | extends accountdocument | 4 | account_document.py |
| accountdocumentline | AccountDocumentLine | extends accountdocumentline | 0 | account_document.py |
AccountDocument — key fields
| Field | Type |
|---|---|
| is_school_invoice | BooleanField |
| admission_register | ForeignKey |
| extracurricular_registration | ForeignKey |
| course_enrollment | ForeignKey |
API Endpoints 2
| Method | Path |
|---|---|
| GET | / |
| GET | /check |
Security & Access
ACL rules: 8 Groups: 1
your_custom_group
Core_School_Library
Core_School Description
Overview
Core_School Description
💡Technical identifier:
core_school_library. See the Technical mode toggle at the top for full data model and API reference.Module Information
📦
Name
Core_School_Library
🏷️
Version
1.0.0
📂
Category
School Library
🔗
Depends
4 modules
Dependencies
basecore_invoicingcore_schoolcore_accounting
Data Models 5
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| librarybooks | LibraryBooks | new | 16 | library_books.py |
| schoolbookloan | schoolBookLoan | new | 9 | school_book_loan.py |
| bookloanline | BookLoanLine | new | 8 | school_book_loan.py |
| schoolsetting | SchoolSetting | extends schoolsetting | 3 | school_setting.py |
| schoolstaff | SchoolStaffInherit | extends schoolstaff | 1 | school_staff.py |
librarybooks — key fields
| Field | Type |
|---|---|
| name | CharField |
| book_id | CharField |
| author | CharField |
| genre | CharField |
| description | TextField |
| synopsis | TextField |
| cover_image | ImageField |
| total_pages | IntegerField |
| publisher | CharField |
| publication_year | DateField |
| language | CharField |
| dimensions | CharField |
| weight | FloatField |
| availability_stock | IntegerField |
| status | CharField |
schoolbookloan — key fields
| Field | Type |
|---|---|
| loan_id | CharField |
| student | ForeignKey |
| student_id | CharField |
| phone_number | CharField |
| start_date | DateField |
| end_date | DateField |
| status | CharField |
| duration | IntegerField |
| invoices | ManyToManyField |
bookloanline — key fields
| Field | Type |
|---|---|
| loan | ForeignKey |
| book | ForeignKey |
| author | CharField |
| genre | CharField |
| publication_year | DateField |
| duration | IntegerField |
| return_date | DateField |
| loan_end_date | DateField |
Security & Access
ACL rules: 14 Groups: 1
Librarian
Core_School_Portal
Core_School_Portal Description
Overview
Core_School_Portal Description
💡Technical identifier:
core_school_portal. See the Technical mode toggle at the top for full data model and API reference.Module Information
📦
Name
Core_School_Portal
🏷️
Version
1.0.0
📂
Category
Core_School_Portal Category
🔗
Depends
2 modules
Dependencies
basecore_school
Data Models 1
| Model | Class | Type | Fields | Source |
|---|---|---|---|---|
| schoolsetting | SchoolSetting | extends schoolsetting | 2 | school_setting.py |
SchoolSetting — key fields
| Field | Type |
|---|---|
| use_pre_account_admission | BooleanField |
| use_post_account_admission | BooleanField |
Security & Access
ACL rules: 4 Groups: 0
Technical Reference
Complete registry of data models and API endpoints across all modules in this scope.
All Data Models 31
| Module | Model | Class | Fields |
|---|---|---|---|
| core_school | academictracking | AcademicTracking | 6 |
| core_school | academictrackingattendance | AcademicTrackingAttendance | 6 |
| core_school | activity_result | ActivityResult | 4 |
| core_school | basecompany | BaseCompany | 3 |
| core_school | user | BaseUsers | 4 |
| core_school | extracurricular | Extracurricular | 15 |
| core_school | extracurricularbatch | ExtracurricularBatch | 4 |
| core_school | extracurricularregistration | ExtracurricularRegistration | 6 |
| core_school | extracurricularscoring | ExtracurricularScoring | 8 |
| core_school | extracurricularscoringline | ExtracurricularScoringLine | 10 |
| core_school | grade | Grade | 3 |
| core_school | gradeline | GradeLine | 8 |
| core_school | lesson_plan | LessonPlan | 5 |
| core_school | school_scoring | SchoolScoring | 15 |
| core_school | school_scoring_daily_assignment | SchoolScoringDailyAssignment | 6 |
| core_school | school_scoring_exam | SchoolScoringExam | 7 |
| core_school | schoolsetting | SchoolSetting | 7 |
| core_school | school_subject_weightage | SchoolSubjectWeightage | 8 |
| core_school | school_subject_weightage_daily_assignment | SchoolSubjectWeightageDailyAssignment | 3 |
| core_school | school_subject_weightage_exam | SchoolSubjectWeightageExam | 3 |
| core_school | schoolsession | Session | 24 |
| core_school | subject | Subject | 4 |
| core_school | user | User | 2 |
| core_school_invoicing | accountdocument | AccountDocument | 4 |
| core_school_invoicing | accountdocumentline | AccountDocumentLine | 0 |
| core_school_library | bookloanline | BookLoanLine | 8 |
| core_school_library | librarybooks | LibraryBooks | 16 |
| core_school_library | schoolsetting | SchoolSetting | 3 |
| core_school_library | schoolstaff | SchoolStaffInherit | 1 |
| core_school_library | schoolbookloan | schoolBookLoan | 9 |
| core_school_portal | schoolsetting | SchoolSetting | 2 |
All API Endpoints 2
| Module | Method | Path |
|---|---|---|
| core_school_invoicing | GET | / |
| core_school_invoicing | GET | /check |