Initial commit

Author: ajgalipeau

.DS_Store

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitattributes

@@ -0,0 +1,3 @@
+{
+    "python.pythonPath": "${workspaceFolder}/venv/bin/python.exe"
+}

galipeau-aaron-week-5/.DS_Store

@@ -0,0 +1,12 @@
+Educational License
+
+This project is licensed under the Educational License for the purposes of learning, academic exercises, and research.
+
+Holder:  
+Aaron Galipeau  
+M.S. Computer Science Student  
+Merrimack College  
+Lecturer: Robert Sands  
+Course: CSC6302 Database Principles
+
+This license allows the project to be used, modified, and shared for educational purposes only. Commercial use or redistribution is strictly prohibited without prior written permission.

galipeau-aaron-week-5/.vscode/settings.json

@@ -0,0 +1,127 @@
+
+# CSC6302 Week 5 Project - Student Database with Toga GUI
+
+This project is a student database application built using Python and Toga GUI. It allows users to manage student records, including displaying student information, adding new students, and calculating average grades from multiple tables in a relational database. The project integrates a business logic layer (BLL) with a data access layer (DAL) and a MySQL backend database.
+
+## Features
+
+- View all students along with their class subjects, grades, teacher names, and average grade.
+- Add new students via the Toga GUI.
+- Simple MySQL integration for data storage.
+- Custom SQL procedures for student data manipulation.
+
+## Prerequisites
+
+Make sure you have the following installed on your system:
+
+- Python 3.10+
+- MySQL Server 9.0 or later
+
+## Project Structure
+
+```
+Grandparent Directory: GitHub
+|-- ./.DS_Store
+|-- ./application
+   |-- ./application/.DS_Store
+   |-- ./application/clean.py
+   |-- ./application/BLL
+      |-- ./application/BLL/students.py
+   |-- ./application/requirements.txt
+   |-- ./application/Makefile
+   |-- ./application/README.md
+   |-- ./application/Connection.py
+   |-- ./application/VIEW
+      |-- ./application/VIEW/.DS_Store
+      |-- ./application/VIEW/view.py
+   |-- ./application/DAL
+      |-- ./application/DAL/teacherDAL.py
+      |-- ./application/DAL/classesDAL.py
+      |-- ./application/DAL/studentDAL.py
+   |-- ./application/main.py
+   |-- ./application/python-path.txt
+|-- ./.vscode
+   |-- ./.vscode/settings.json
+|-- ./togavenv
+   |-- ./togavenv/.DS_Store
+   |-- ./togavenv/bin
+   |-- ./togavenv/include
+   |-- ./togavenv/pyvenv.cfg
+   |-- ./togavenv/lib
+   |-- ./togavenv/share
+|-- ./sql
+   |-- ./sql/users.sql
+   |-- ./sql/ddl.sql
+   |-- ./sql/procedure_functions.sql
+   |-- ./sql/query.sql
+   |-- ./sql/dml.sql
+   |-- ./sql/permissions.sql
+```
+
+## Installation and Setup
+
+1. **Clone the Repository**
+   ```bash
+   git clone https://github.com/yourusername/database_principles_csc6302.git
+   cd database_principles_csc6302
+   ```
+
+2. **Create a Virtual Environment**
+   ```bash
+   python3 -m venv togavenv
+   source togavenv/bin/activate  # On Windows use `togavenv\Scripts\activate`
+   ```
+
+3. **Install Required Packages**
+   ```bash
+   pip install -r application/requirements.txt
+   ```
+
+4. **MySQL Database Setup**
+   - Ensure that MySQL is installed and running.
+   - Execute the SQL scripts in the `sql/` directory to create tables, add procedures, and insert sample data.
+
+   ```bash
+   mysql -u admin_user -p < sql/ddl.sql
+   mysql -u admin_user -p < sql/procedure_functions.sql
+   mysql -u admin_user -p < sql/dml.sql
+   ```
+
+## Running the Application
+
+1. **Start the Toga GUI**
+   ```bash
+   python3 application/main.py
+   ```
+
+   This will open the GUI window for the student database management application.
+
+2. **Add a Student**
+   - Fill out the form on the right panel of the GUI to add a new student.
+   - Click "Add User" to submit the form.
+   - The data table on the left will refresh to display the updated list of students.
+
+## Makefile Commands
+
+The `Makefile` includes a convenient command for cleaning up cache files:
+
+- **Clean Cache Files**
+  ```bash
+  make clean
+  ```
+  This command will remove all `__pycache__` files and `.DS_Store` files from the project.
+
+## License
+
+Educational License
+
+This project is licensed under the Educational License for the purposes of learning, academic exercises, and research.
+
+Holder:  
+Aaron Galipeau  
+M.S. Computer Science Student  
+Merrimack College  
+Lecturer: Robert Sands  
+Course: CSC6302 Database Principles
+
+This license allows the project to be used, modified, and shared for educational purposes only. Commercial use or redistribution is strictly prohibited without prior written permission.

galipeau-aaron-week-5/LICENSE.txt

@@ -0,0 +1,247 @@
+# BLL/students.py
+from DAL.studentDAL import StudentDAL
+from DAL.teacherDAL import TeacherDAL
+from DAL.classesDAL import ClassesDAL
+
+# Student Class
+class Student:
+    """
+    The Student class represents a student entity and provides methods to interact with the student data.
+    Attributes:
+        id (int, optional): The unique identifier for the student.
+        first_name (str, optional): The first name of the student.
+        last_name (str, optional): The last name of the student.
+        email (str, optional): The email address of the student.
+        date_of_birth (str, optional): The date of birth of the student.
+        grade (str, optional): The grade of the student.
+    Methods:
+        add():
+            Adds a new student record using a stored procedure.
+        read():
+            Reads the student record based on the student's ID.
+        getStudents():
+            Retrieves all student records.
+        getStudentsWithClasses():
+            Retrieves all student records along with their associated classes.
+    """
+    def __init__(self, id=None, first_name=None, last_name=None, email=None, date_of_birth=None, grade=None):
+        """
+        Initializes a new instance of the Student class.
+
+        Args:
+            id (int, optional): The unique identifier for the student. Defaults to None.
+            first_name (str, optional): The first name of the student. Defaults to None.
+            last_name (str, optional): The last name of the student. Defaults to None.
+            email (str, optional): The email address of the student. Defaults to None.
+            date_of_birth (str, optional): The date of birth of the student. Defaults to None.
+            grade (str, optional): The grade of the student. Defaults to None.
+        """
+        self.studentDal = StudentDAL()
+        self.id = id
+        self.first_name = first_name
+        self.last_name = last_name
+        self.email = email
+        self.date_of_birth = date_of_birth
+        self.grade = grade
+
+    def add(self):
+        """
+        Adds a new student record to the database using a stored procedure.
+
+        This method calls the `add_using_procedure` method of the `studentDal` object,
+        passing the student's first name, last name, email, date of birth, and grade
+        as parameters.
+
+        Parameters:
+        None
+
+        Returns:
+        None
+        """
+        self.studentDal.add_using_procedure(
+            self.first_name,
+            self.last_name,
+            self.email,
+            self.date_of_birth,
+            self.grade
+        )
+
+    def read(self):
+        """
+        Reads the student data from the data access layer (DAL) using the student's ID.
+
+        Returns:
+            dict: A dictionary containing the student's data.
+        """
+        return self.studentDal.read(self.id)
+    
+    def getStudents(self):
+        """
+        Retrieves a list of all students from the data access layer.
+
+        Returns:
+            list: A list of student records.
+        """
+        return self.studentDal.read_all()
+    
+    def getStudentsWithClasses(self):
+        """
+        Retrieves a list of students along with their associated classes.
+
+        Returns:
+            list: A list of dictionaries, where each dictionary contains student information
+                  and their associated classes.
+        """
+        return self.studentDal.read_all_with_classes()
+
+class Teacher:
+    """
+    A class to represent a teacher.
+
+    Attributes:
+    ----------
+    id : int, optional
+        The unique identifier for the teacher (default is None).
+    first_name : str, optional
+        The first name of the teacher (default is None).
+    last_name : str, optional
+        The last name of the teacher (default is None).
+    email : str, optional
+        The email address of the teacher (default is None).
+    teacherDal : TeacherDAL
+        An instance of the TeacherDAL class for database operations.
+
+    Methods:
+    -------
+    add():
+        Adds the teacher's information to the database.
+    read():
+        Reads the teacher's information from the database using the teacher's id.
+    """
+
+    def __init__(self, id=None, first_name=None, last_name=None, email=None):
+        """
+        Constructs all the necessary attributes for the teacher object.
+
+        Parameters:
+        ----------
+        id : int, optional
+            The unique identifier for the teacher (default is None).
+        first_name : str, optional
+            The first name of the teacher (default is None).
+        last_name : str, optional
+            The last name of the teacher (default is None).
+        email : str, optional
+            The email address of the teacher (default is None).
+        """
+        self.teacherDal = TeacherDAL()
+        self.id = id
+        self.first_name = first_name
+        self.last_name = last_name
+        self.email = email
+
+    def add(self):
+        """
+        Adds the teacher's information to the database.
+
+        This method uses the TeacherDAL instance to add the teacher's
+        first name, last name, and email to the database.
+        """
+        self.teacherDal.add(
+            self.first_name,
+            self.last_name,
+            self.email
+        )
+
+    def read(self):
+        """
+        Reads the teacher's information from the database using the teacher's id.
+
+        Returns:
+        -------
+        dict
+            A dictionary containing the teacher's information retrieved from the database.
+        """
+        return self.teacherDal.read(self.id)
+
+class Class:
+    """
+    A class to represent a school class.
+
+    Attributes:
+    ----------
+    id : int, optional
+        The unique identifier for the class (default is None).
+    room_number : str, optional
+        The room number where the class is held (default is None).
+    subject : str, optional
+        The subject taught in the class (default is None).
+    class_grade : str, optional
+        The grade level of the class (default is None).
+    teacher_id : int, optional
+        The unique identifier for the teacher of the class (default is None).
+    student_id : int, optional
+        The unique identifier for the student in the class (default is None).
+    classDal : ClassesDAL
+        An instance of the ClassesDAL class for database operations.
+
+    Methods:
+    -------
+    add():
+        Adds the class information to the database.
+    read():
+        Reads the class information from the database using the class id.
+    """
+
+    def __init__(self, id=None, room_number=None, subject=None, class_grade=None, teacher_id=None, student_id=None):
+        """
+        Constructs all the necessary attributes for the class object.
+
+        Parameters:
+        ----------
+        id : int, optional
+            The unique identifier for the class (default is None).
+        room_number : str, optional
+            The room number where the class is held (default is None).
+        subject : str, optional
+            The subject taught in the class (default is None).
+        class_grade : str, optional
+            The grade level of the class (default is None).
+        teacher_id : int, optional
+            The unique identifier for the teacher of the class (default is None).
+        student_id : int, optional
+            The unique identifier for the student in the class (default is None).
+        """
+        self.classDal = ClassesDAL()
+        self.id = id
+        self.room_number = room_number
+        self.subject = subject
+        self.class_grade = class_grade
+        self.teacher_id = teacher_id
+        self.student_id = student_id
+
+    def add(self):
+        """
+        Adds the class information to the database.
+
+        This method uses the ClassesDAL instance to add the class's
+        room number, subject, class grade, teacher id, and student id to the database.
+        """
+        self.classDal.add(
+            self.room_number,
+            self.subject,
+            self.class_grade,
+            self.teacher_id,
+            self.student_id
+        )
+
+    def read(self):
+        """
+        Reads the class information from the database using the class id.
+
+        Returns:
+        -------
+        dict
+            A dictionary containing the class information retrieved from the database.
+        """
+        return self.classDal.read(self.id)