Backend/feature/db models

backend/.gitignore

@@ -7,4 +7,5 @@ __pycache__/
 htmlcov/
 docs/_build/
 dist/
-venv/
+venv/
+*.env

backend/environment.env

@@ -0,0 +1,2 @@
+DB_HOST=postgresql://postgres:postgres@localhost:5432/sel3_db
+

backend/project/__init__.py

@@ -2,17 +2,27 @@
 This file is the base of the Flask API. It contains the basic structure of the API.    
 """
 
-from flask import Flask, jsonify
+from flask import Flask
+from flask_sqlalchemy import SQLAlchemy
 from .endpoints.index import index_bp
 
+db = SQLAlchemy()
+
 def create_app():
     """
     Create a Flask application instance.
     Returns:
         Flask -- A Flask application instance
     """
-    app = Flask(__name__)
 
+    app = Flask(__name__)
     app.register_blueprint(index_bp)
 
     return app
+
+def init_db(db_uri):
+    """Initialize the database with the given uri"""
+    app = create_app()
+    app.config["SQLALCHEMY_DATABASE_URI"] = db_uri
+    db.init_app(app)
+    return app

backend/project/__main__.py

@@ -1,9 +1,12 @@
 """Main entry point for the application."""
 from sys import path
+from os import getenv
+from dotenv import load_dotenv
+from project import init_db
 
 path.append(".")
 
 if __name__ == "__main__":
-    from project import create_app
-    app = create_app()
+    load_dotenv(dotenv_path='environment.env')
+    app = init_db(getenv("DB_HOST"))
     app.run(debug=True)

backend/project/endpoints/index.py

@@ -1,10 +1,16 @@
+"""Index api point"""
 from flask import Blueprint
 from flask_restful import Resource
 
 index_bp = Blueprint("index", __name__)
 
+
 class Index(Resource):
+    """Temporary"""
+
     def get(self):
+        """Hello world"""
         return {"Message": "Hello World!"}
-
-index_bp.add_url_rule("/", view_func=Index.as_view("index"))
+
+
+index_bp.add_url_rule("/", view_func=Index.as_view("index"))

backend/project/models/course_relations.py

@@ -0,0 +1,24 @@
+"""Models for relation between users and courses"""
+# pylint: disable=too-few-public-methods
+
+from sqlalchemy import Integer, Column, ForeignKey, PrimaryKeyConstraint, String
+from project import db
+
+class BaseCourseRelation(db.Model):
+    """Base class for course relation models"""
+
+    __abstract__ = True
+
+    course_id = Column(Integer, ForeignKey('Courses.course_id'), nullable=False)
+    uid = Column(String(255), ForeignKey("Users.uid"), nullable=False)
+    __table_args__ = PrimaryKeyConstraint("course_id", "uid")
+
+class CourseAdmins(BaseCourseRelation):
+    """Admin to course relation model"""
+
+    __tablename__ = "course_admins"
+
+class CourseStudents(BaseCourseRelation):
+    """Student to course relation model"""
+
+    __tablename__ = "course_students"

backend/project/models/courses.py

@@ -0,0 +1,14 @@
+"""The Courses model"""
+# pylint: disable=too-few-public-methods
+from sqlalchemy import Integer, Column, ForeignKey, String
+from project import db
+
+
+class Courses(db.Model):
+    """Course model"""
+
+    __tablename__ = "courses"
+    course_id = Column(Integer, primary_key=True)
+    name = Column(String(50), nullable=False)
+    ufora_id = Column(String(50), nullable=True)
+    teacher = Column(String(255), ForeignKey("Users.uid"), nullable=False)

backend/project/models/projects.py

@@ -0,0 +1,20 @@
+"""Model for projects"""
+# pylint: disable=too-few-public-methods
+from sqlalchemy import ARRAY, Boolean, Column, DateTime, ForeignKey, Integer, String, Text
+from project import db
+
+class Projects(db.Model):
+    """Project model"""
+
+    __tablename__ = "projects"
+    project_id = Column(Integer, primary_key=True)
+    title = Column(String(50), nullable=False, unique=False)
+    descriptions = Column(Text, nullable=False)
+    assignment_file = Column(String(50))
+    deadline = Column(DateTime(timezone=True))
+    course_id = Column(Integer, ForeignKey("Courses.course_id"), nullable=False)
+    visible_for_students = Column(Boolean, nullable=False)
+    archieved = Column(Boolean, nullable=False)
+    test_path = Column(String(50))
+    script_name = Column(String(50))
+    regex_expressions = Column(ARRAY(String(50)))

backend/project/models/submissions.py

@@ -0,0 +1,16 @@
+"""Model for submissions"""
+# pylint: disable=too-few-public-methods
+from sqlalchemy import Column,String,ForeignKey,Integer,CheckConstraint,DateTime,Boolean
+from project import db
+
+class Submissions(db.Model):
+    """Submission model"""
+
+    __tablename__ = "submissions"
+    submission_id = Column(Integer, nullable=False, primary_key=True)
+    uid = Column(String(255), ForeignKey("Users.uid"), nullable=False)
+    project_id = Column(Integer, ForeignKey("Projects.project_id"), nullable=False)
+    grading = Column(Integer, CheckConstraint("grading >= 0 AND grading <= 20"))
+    submission_time = Column(DateTime(timezone=True), nullable=False)
+    submission_path = Column(String(50), nullable=False)
+    submission_status = Column(Boolean, nullable=False)

backend/project/models/users.py

@@ -0,0 +1,13 @@
+"""Model for users"""
+# pylint: disable=too-few-public-methods
+from sqlalchemy import Boolean, Column, String
+from project import db
+
+
+class Users(db.Model):
+    """User model"""
+
+    __tablename__ = "users"
+    uid = Column(String(255), primary_key=True)
+    is_teacher = Column(Boolean)
+    is_admin = Column(Boolean)

backend/requirements.txt

@@ -1,2 +1,4 @@
 flask
 flask-restful
+flask-sqlalchemy
+python-dotenv