feat: #52 created schemas for newest models

- updated the schemas in order to meet the new architecture

- cleaned the dependencies at `requirements.txt`

- include code coverage for actions

.github/workflows/pr-conventional-commits.yml

@@ -9,7 +9,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PR Conventional Commit Validation
-        uses:  ytanikin/[email protected]
+        uses: ytanikin/[email protected]
         with:
-          task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert"]'
+          task_types: '["feat","fix","docs","test","ci","refac", 
+            "perf","chore","revert"]'
           add_label: 'false'

.github/workflows/python-app.yml

@@ -1,6 +1,3 @@
-# This workflow will install Python dependencies, run tests and lint with a single version of Python
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
-
 name: Python application
 
 on:
@@ -19,25 +16,40 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+
     - name: Set up Python 3.10
       uses: actions/setup-python@v3
       with:
         python-version: "3.10"
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pytest black
+        pip install flake8 pytest black coverage
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    -name: Format with black
+
+    - name: Format with black
       run: |
         black .
+
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test with pytest
+
+    - name: Run tests with coverage
+      run: |
+        coverage run -m pytest
+
+    - name: Generate coverage report
       run: |
-        pytest
+        coverage report
+        coverage html
 
+    - name: Upload coverage report
+      uses: actions/upload-artifact@v3
+      with:
+        name: coverage-report
+        path: htmlcov/

.pre-commit-config.yaml

@@ -13,3 +13,9 @@ repos:
         language: system
         pass_filenames: false
 
+      - id: format-yaml
+        name: Format YAML Files
+        entry: yamlfmt
+        language: python
+        types: [yaml]
+        files: \.(yml|yaml)$

.pylintrc

@@ -81,7 +81,7 @@ indent-string = '    '
 indent-after-paren = 4
 
 # Maximum number of characters on a single line.
-max-line-length = 120
+max-line-length = 80
 msg-template = "{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}"
 output-format = colorized
 

app/schemas/activity.py

@@ -0,0 +1,42 @@
+# app/schemas/activity.py
+
+from typing import Optional
+from enum import Enum
+from datetime import datetime
+from pydantic import BaseModel
+from app.database.models import Question
+
+
+class ActivityType(str, Enum):
+    question = "question"
+
+
+class ActivityBase(BaseModel):
+    type: ActivityType
+    activity: str
+    created_at: datetime
+
+
+class ActivityCreate(ActivityBase):
+    pass
+
+
+class ActivityUpdate(ActivityBase):
+    pass
+
+
+class ActivityInDBBase(ActivityBase):
+    id: int
+    user_id: int
+    study_session_id: int
+
+    class Config:
+        orm_mode = True
+
+
+class Activity(ActivityInDBBase):
+    question: Optional["Question"] = None
+
+
+class ActivityInDB(ActivityInDBBase):
+    pass

app/schemas/answer.py

@@ -0,0 +1,37 @@
+# app/schemas/answer.py
+
+from typing import (
+    Optional,
+    List,
+)
+from pydantic import BaseModel
+
+
+class AnswerBase(BaseModel):
+    answer: str
+
+
+class AnswerCreate(AnswerBase):
+    pass
+
+
+class AnswerUpdate(AnswerBase):
+    pass
+
+
+class AnswerInDBBase(AnswerBase):
+    id: int
+    user_id: int
+    question_id: int
+
+    class Config:
+        orm_mode = True
+
+
+class Answer(AnswerInDBBase):
+    parent_answer: Optional["Answer"] = None
+    child_answers: Optional[List["Answer"]] = []
+
+
+class AnswerInDB(AnswerInDBBase):
+    pass

app/schemas/question.py

@@ -0,0 +1,35 @@
+from typing import (
+    Optional,
+    List,
+)
+from pydantic import BaseModel
+from app.database.models import Answer
+
+
+class QuestionBase(BaseModel):
+    question: str
+
+
+class QuestionCreate(QuestionBase):
+    pass
+
+
+class QuestionUpdate(QuestionBase):
+    pass
+
+
+class QuestionInDBBase(QuestionBase):
+    id: int
+    user_id: int
+    activity_id: int
+
+    class Config:
+        orm_mode = True
+
+
+class Question(QuestionInDBBase):
+    answers: Optional[List["Answer"]] = []
+
+
+class QuestionInDB(QuestionInDBBase):
+    pass

app/schemas/study_session.py

@@ -0,0 +1,38 @@
+# app/schemas/study_session.py
+
+from typing import (
+    List,
+    Optional,
+)
+from datetime import datetime
+from pydantic import BaseModel
+from app.database.models import Activity
+
+
+class StudySessionBase(BaseModel):
+    start_time: datetime
+    end_time: Optional[datetime] = None
+
+
+class StudySessionCreate(StudySessionBase):
+    pass
+
+
+class StudySessionUpdate(StudySessionBase):
+    pass
+
+
+class StudySessionInDBBase(StudySessionBase):
+    id: int
+    user_id: int
+
+    class Config:
+        orm_mode = True
+
+
+class StudySession(StudySessionInDBBase):
+    activities: Optional[List["Activity"]] = []
+
+
+class StudySessionInDB(StudySessionInDBBase):
+    pass

app/schemas/user.py

@@ -1,6 +1,12 @@
 # app/schemas/user.py
 
+from typing import (
+    List,
+    Optional,
+)
+from datetime import datetime
 from pydantic import BaseModel
+from app.database.models import Activity, Answer, Question, StudySession
 
 
 class UserBase(BaseModel):
@@ -19,6 +25,15 @@ class UserUpdate(UserBase):
 
 class UserInDBBase(UserBase):
     id: int
+    created_at: datetime
+    updated_at: datetime
 
     class Config:
         orm_mode = True
+
+
+class User(UserInDBBase):
+    study_sessions: Optional[List["StudySession"]] = []
+    activities: Optional[List["Activity"]] = []
+    questions: Optional[List["Question"]] = []
+    answers: Optional[List["Answer"]] = []