diff --git a/README.md b/README.md index 4d4b909..eda4ba4 100644 --- a/README.md +++ b/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 diff --git a/app/__init__.py b/aura/__init__.py similarity index 100% rename from app/__init__.py rename to aura/__init__.py diff --git a/main.py b/aura/__main__.py similarity index 91% rename from main.py rename to aura/__main__.py index 1dda034..8c42e19 100644 --- a/main.py +++ b/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, ) diff --git a/app/api/__init__.py b/aura/api/__init__.py similarity index 100% rename from app/api/__init__.py rename to aura/api/__init__.py diff --git a/app/api/endpoints/__init__.py b/aura/api/endpoints/__init__.py similarity index 100% rename from app/api/endpoints/__init__.py rename to aura/api/endpoints/__init__.py diff --git a/app/api/endpoints/activity.py b/aura/api/endpoints/activity.py similarity index 93% rename from app/api/endpoints/activity.py rename to aura/api/endpoints/activity.py index 5acdda1..9a4e27b 100644 --- a/app/api/endpoints/activity.py +++ b/aura/api/endpoints/activity.py @@ -6,13 +6,13 @@ 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, diff --git a/app/api/endpoints/answer.py b/aura/api/endpoints/answer.py similarity index 93% rename from app/api/endpoints/answer.py rename to aura/api/endpoints/answer.py index 06c132b..251b52d 100644 --- a/app/api/endpoints/answer.py +++ b/aura/api/endpoints/answer.py @@ -6,13 +6,13 @@ 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, diff --git a/app/api/endpoints/question.py b/aura/api/endpoints/question.py similarity index 93% rename from app/api/endpoints/question.py rename to aura/api/endpoints/question.py index 16a1da3..eb4134b 100644 --- a/app/api/endpoints/question.py +++ b/aura/api/endpoints/question.py @@ -6,13 +6,13 @@ 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, diff --git a/app/api/endpoints/study_session.py b/aura/api/endpoints/study_session.py similarity index 94% rename from app/api/endpoints/study_session.py rename to aura/api/endpoints/study_session.py index d237611..851ede5 100644 --- a/app/api/endpoints/study_session.py +++ b/aura/api/endpoints/study_session.py @@ -6,13 +6,13 @@ 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, diff --git a/app/api/endpoints/user.py b/aura/api/endpoints/user.py similarity index 93% rename from app/api/endpoints/user.py rename to aura/api/endpoints/user.py index 39ea660..e4351a5 100644 --- a/app/api/endpoints/user.py +++ b/aura/api/endpoints/user.py @@ -6,13 +6,13 @@ 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, diff --git a/app/database/__init__.py b/aura/database/__init__.py similarity index 100% rename from app/database/__init__.py rename to aura/database/__init__.py diff --git a/app/database/models.py b/aura/database/models.py similarity index 98% rename from app/database/models.py rename to aura/database/models.py index 845ade7..eb65b2e 100644 --- a/app/database/models.py +++ b/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): diff --git a/app/database/session.py b/aura/database/session.py similarity index 100% rename from app/database/session.py rename to aura/database/session.py diff --git a/app/repositories/__init__.py b/aura/repositories/__init__.py similarity index 100% rename from app/repositories/__init__.py rename to aura/repositories/__init__.py diff --git a/app/repositories/activity_repository.py b/aura/repositories/activity_repository.py similarity index 90% rename from app/repositories/activity_repository.py rename to aura/repositories/activity_repository.py index be2a525..16f273b 100644 --- a/app/repositories/activity_repository.py +++ b/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: diff --git a/app/repositories/answer_repository.py b/aura/repositories/answer_repository.py similarity index 90% rename from app/repositories/answer_repository.py rename to aura/repositories/answer_repository.py index 9199607..b891c59 100644 --- a/app/repositories/answer_repository.py +++ b/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: diff --git a/app/repositories/question_repository.py b/aura/repositories/question_repository.py similarity index 90% rename from app/repositories/question_repository.py rename to aura/repositories/question_repository.py index c0e23e1..58ce6c7 100644 --- a/app/repositories/question_repository.py +++ b/aura/repositories/question_repository.py @@ -1,8 +1,8 @@ # app/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: diff --git a/app/repositories/study_session_repository.py b/aura/repositories/study_session_repository.py similarity index 91% rename from app/repositories/study_session_repository.py rename to aura/repositories/study_session_repository.py index 25f95c8..dca0068 100644 --- a/app/repositories/study_session_repository.py +++ b/aura/repositories/study_session_repository.py @@ -1,8 +1,8 @@ # app/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( diff --git a/app/repositories/user_repository.py b/aura/repositories/user_repository.py similarity index 90% rename from app/repositories/user_repository.py rename to aura/repositories/user_repository.py index 9851933..61fba7d 100644 --- a/app/repositories/user_repository.py +++ b/aura/repositories/user_repository.py @@ -1,8 +1,8 @@ # app/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: diff --git a/app/schemas/__init__.py b/aura/schemas/__init__.py similarity index 100% rename from app/schemas/__init__.py rename to aura/schemas/__init__.py diff --git a/app/schemas/activity.py b/aura/schemas/activity.py similarity index 94% rename from app/schemas/activity.py rename to aura/schemas/activity.py index 4513c58..5919bf7 100644 --- a/app/schemas/activity.py +++ b/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): diff --git a/app/schemas/answer.py b/aura/schemas/answer.py similarity index 93% rename from app/schemas/answer.py rename to aura/schemas/answer.py index 310d98b..3608dcc 100644 --- a/app/schemas/answer.py +++ b/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): diff --git a/app/schemas/question.py b/aura/schemas/question.py similarity index 92% rename from app/schemas/question.py rename to aura/schemas/question.py index 6d6a977..3efe113 100644 --- a/app/schemas/question.py +++ b/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): diff --git a/app/schemas/study_session.py b/aura/schemas/study_session.py similarity index 93% rename from app/schemas/study_session.py rename to aura/schemas/study_session.py index 7214d55..c5e1116 100644 --- a/app/schemas/study_session.py +++ b/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): diff --git a/app/schemas/user.py b/aura/schemas/user.py similarity index 89% rename from app/schemas/user.py rename to aura/schemas/user.py index ef8a7b9..79a50ff 100644 --- a/app/schemas/user.py +++ b/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): diff --git a/app/services/__init__.py b/aura/services/__init__.py similarity index 100% rename from app/services/__init__.py rename to aura/services/__init__.py