refac: #52 update folder structure as package (#63)

- made the rest api a package

- this could be useful when creating cli

.pre-commit-config.yaml

@@ -19,3 +19,9 @@ repos:
         language: python
         types: [yaml]
         files: \.(yml|yaml)$
+
+      - id: rust-check
+        name: Check Rust Code
+        entry: ./scripts/check_rust.sh
+        files: discord/
+        language: rust

README.md

@@ -1,4 +1,4 @@
-# AURA - Adaptative Utility and Routine Assistant
+# AURA - Adaptive Utility and Routine Assistant
 
 AURA is an innovative API designed to revolutionize the way students learn. It provides a comprehensive platform where students can access a wide range of educational resources, receive personalized recommendations, and track their progress. AURA is built to enhance the learning experience by offering targeted support, adaptive learning routines, and intelligent assistance.
 
@@ -41,10 +41,10 @@ To use AURA, follow these steps:
     pip install -r requirements.txt
     ```
 
-3. Run the application:
+3. Run the main application:
 
     ```bash
-    python main.py
+    python -m aura
     ```
 
 ## Acknowledgements

main.py → aura/__main__.py

@@ -5,14 +5,14 @@
 )
 from sqlalchemy.orm import Session
 import uvicorn
-from app.api.endpoints import (
+from aura.api.endpoints import (
     activity,
     answer,
     question,
     study_session,
     user,
 )
-from app.database.session import (
+from aura.database.session import (
     Base,
     engine,
 )

app/api/endpoints/activity.py → aura/api/endpoints/activity.py

@@ -1,18 +1,18 @@
-# app/api/endpoints/activity.py
+# aura/api/endpoints/activity.py
 
 from fastapi import (
     APIRouter,
     Depends,
     HTTPException,
 )
 from sqlalchemy.orm import Session
-from app.database.session import get_db
-from app.schemas.activity import (
+from aura.database.session import get_db
+from aura.schemas.activity import (
     ActivityCreate,
     ActivityUpdate,
     ActivityInDBBase,
 )
-from app.repositories.activity_repository import (
+from aura.repositories.activity_repository import (
     create_activity,
     get_activity,
     get_activities,

app/api/endpoints/answer.py → aura/api/endpoints/answer.py

@@ -1,18 +1,18 @@
-# app/api/endpoints/answer.py
+# aura/api/endpoints/answer.py
 
 from fastapi import (
     APIRouter,
     Depends,
     HTTPException,
 )
 from sqlalchemy.orm import Session
-from app.database.session import get_db
-from app.schemas.answer import (
+from aura.database.session import get_db
+from aura.schemas.answer import (
     AnswerCreate,
     AnswerUpdate,
     AnswerInDBBase,
 )
-from app.repositories.answer_repository import (
+from aura.repositories.answer_repository import (
     create_answer,
     get_answer,
     get_answers,

app/api/endpoints/question.py → aura/api/endpoints/question.py

@@ -1,18 +1,18 @@
-# app/api/endpoints/question.py
+# aura/api/endpoints/question.py
 
 from fastapi import (
     APIRouter,
     Depends,
     HTTPException,
 )
 from sqlalchemy.orm import Session
-from app.database.session import get_db
-from app.schemas.question import (
+from aura.database.session import get_db
+from aura.schemas.question import (
     QuestionCreate,
     QuestionUpdate,
     QuestionInDBBase,
 )
-from app.repositories.question_repository import (
+from aura.repositories.question_repository import (
     create_question,
     get_question,
     get_questions,

app/api/endpoints/study_session.py → aura/api/endpoints/study_session.py

@@ -1,18 +1,18 @@
-# app/api/endpoints/study_session.py
+# aura/api/endpoints/study_session.py
 
 from fastapi import (
     APIRouter,
     Depends,
     HTTPException,
 )
 from sqlalchemy.orm import Session
-from app.database.session import get_db
-from app.schemas.study_session import (
+from aura.database.session import get_db
+from aura.schemas.study_session import (
     StudySessionCreate,
     StudySessionUpdate,
     StudySessionInDBBase,
 )
-from app.repositories.study_session_repository import (
+from aura.repositories.study_session_repository import (
     create_study_session,
     get_study_session,
     get_study_sessions,

app/api/endpoints/user.py → aura/api/endpoints/user.py

@@ -1,18 +1,18 @@
-# app/api/endpoints/user.py
+# aura/api/endpoints/user.py
 
 from fastapi import (
     APIRouter,
     Depends,
     HTTPException,
 )
 from sqlalchemy.orm import Session
-from app.database.session import get_db
-from app.schemas.user import (
+from aura.database.session import get_db
+from aura.schemas.user import (
     UserCreate,
     UserUpdate,
     UserInDBBase,
 )
-from app.repositories.user_repository import (
+from aura.repositories.user_repository import (
     create_user,
     get_user,
     get_users,

app/database/models.py → aura/database/models.py

@@ -9,7 +9,7 @@
     DateTime,
 )
 from sqlalchemy.orm import relationship
-from app.database.session import Base
+from aura.database.session import Base
 
 
 class ActivityType(Enum):

app/database/session.py → aura/database/session.py

@@ -1,4 +1,4 @@
-# app/database/session.py
+# aura/database/session.py
 
 import os
 from typing import Generator

app/repositories/activity_repository.py → aura/repositories/activity_repository.py

@@ -1,6 +1,6 @@
 from sqlalchemy.orm import Session
-from app.database.models import Activity
-from app.schemas.activity import ActivityCreate, ActivityUpdate
+from aura.database.models import Activity
+from aura.schemas.activity import ActivityCreate, ActivityUpdate
 
 
 def create_activity(db: Session, activity: ActivityCreate) -> Activity:

app/repositories/answer_repository.py → aura/repositories/answer_repository.py

@@ -1,6 +1,6 @@
 from sqlalchemy.orm import Session
-from app.database.models import Answer
-from app.schemas.answer import AnswerCreate, AnswerUpdate
+from aura.database.models import Answer
+from aura.schemas.answer import AnswerCreate, AnswerUpdate
 
 
 def create_answer(db: Session, answer: AnswerCreate) -> Answer:

app/repositories/question_repository.py → aura/repositories/question_repository.py

@@ -1,8 +1,8 @@
-# app/repositories/question_repository.py
+# aura/repositories/question_repository.py
 
 from sqlalchemy.orm import Session
-from app.database.models import Question
-from app.schemas.question import QuestionCreate, QuestionUpdate
+from aura.database.models import Question
+from aura.schemas.question import QuestionCreate, QuestionUpdate
 
 
 def create_question(db: Session, question: QuestionCreate) -> Question:

app/repositories/study_session_repository.py → aura/repositories/study_session_repository.py

@@ -1,8 +1,8 @@
-# app/repositories/study_repository.py
+# aura/repositories/study_repository.py
 
 from sqlalchemy.orm import Session
-from app.database.models import StudySession
-from app.schemas.study_session import StudySessionCreate, StudySessionUpdate
+from aura.database.models import StudySession
+from aura.schemas.study_session import StudySessionCreate, StudySessionUpdate
 
 
 def create_study_session(

app/repositories/user_repository.py → aura/repositories/user_repository.py

@@ -1,8 +1,8 @@
-# app/repositories/user_repository.py
+# aura/repositories/user_repository.py
 
 from sqlalchemy.orm import Session
-from app.database.models import User
-from app.schemas.user import UserCreate, UserUpdate
+from aura.database.models import User
+from aura.schemas.user import UserCreate, UserUpdate
 
 
 def create_user(db: Session, user: UserCreate) -> User:

app/schemas/activity.py → aura/schemas/activity.py

@@ -2,7 +2,7 @@
 from enum import Enum
 from datetime import datetime
 from pydantic import BaseModel
-from app.database.models import Question
+from aura.database.models import Question
 
 
 class ActivityType(str, Enum):

app/schemas/answer.py → aura/schemas/answer.py

@@ -1,6 +1,6 @@
 from typing import Optional, List
 from pydantic import BaseModel
-from app.database.models import Answer
+from aura.database.models import Answer
 
 
 class AnswerBase(BaseModel):

app/schemas/question.py → aura/schemas/question.py

@@ -1,6 +1,6 @@
 from typing import Optional, List
 from pydantic import BaseModel
-from app.database.models import Answer
+from aura.database.models import Answer
 
 
 class QuestionBase(BaseModel):

app/schemas/study_session.py → aura/schemas/study_session.py

@@ -1,7 +1,7 @@
 from typing import List, Optional
 from datetime import datetime
 from pydantic import BaseModel
-from app.database.models import Activity
+from aura.database.models import Activity
 
 
 class StudySessionBase(BaseModel):

app/schemas/user.py → aura/schemas/user.py

@@ -1,7 +1,7 @@
 from typing import List, Optional
 from datetime import datetime
 from pydantic import BaseModel
-from app.database.models import Activity, Answer, Question, StudySession
+from aura.database.models import Activity, Answer, Question, StudySession
 
 
 class UserBase(BaseModel):

scripts/check_rust.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+# Set up Rust environment (assuming Rust is already installed)
+rust_version="1.57.0"
+
+# Optionally install Rustup
+# curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+
+# Install Rust components
+rustup component add rustfmt clippy
+
+# Check for Rust errors
+cargo check --all
+
+# Run Rustfmt
+cargo fmt --all -- --check
+
+# Run Clippy
+cargo clippy --all -- -D warnings