GradeForge

GradeForge Documentation

Version 1.0

Introduction

GradeForge is a comprehensive academic management system designed to streamline the process of managing student grades, subjects, and academic records. This documentation provides a detailed overview of the system's architecture, components, and functionality, based on the actual Python codebase.

Purpose

GradeForge serves as a centralized platform for:

  • Managing student academic records for different student types (Generic, High School, College).
  • Tracking subject enrollments and grades (numeric scores for High School, letter grades/points for College).
  • Generating performance reports and transcripts.
  • Persisting data locally using JSON.

Target Users

Educational administrators or individuals needing a simple system to manage student academic data.

This documentation site provides comprehensive information about GradeForge. Navigate through the sections using the sidebar to learn more about specific aspects of the system. You can also access the GitHub repository for the source code and the original documentation.

Quick Links

System Architecture

GradeForge is built using Python. It features distinct classes for students, subjects, and grades. A main GradeForge class in gradeforge.py orchestrates user interactions via a command-line interface and manages data persistence.

Core Modules (as Python files)

  1. student.py: Defines the base Student class and its specialized subclasses HighSchoolStudent and CollegeStudent.
  2. subject.py: Defines the Subject class, representing courses students can enroll in.
  3. grade.py: Defines the Grade class, representing individual grade entries.
  4. gradeforge.py: Contains the main GradeForge application class, handling CLI interactions, data loading/saving, and coordinating operations between students, subjects, and grades.

Class Hierarchy

Student (from student.py)
├── HighSchoolStudent (from student.py)
└── CollegeStudent (from student.py)

Subject (from subject.py)
Grade (from grade.py)

GradeForge (from gradeforge.py - Orchestrator/Application Class)