Merge pull request #17 from wednesday-solutions/feat/restructuring

feat - restructing of module

.gitignore

@@ -1,6 +1,12 @@
-venv/
-__pycache__/
-*/__pycache__/
-*/*/__pycache__/
-python-fastapi/
-.vscode/
+# Local Environment
+env
+venv
+
+# Config file
+.env
+
+*__pycache__*
+
+# Temp files
+tmp/
+temp/

alembic/versions/45f7c66353f4_initialize_all_models.py

@@ -9,9 +9,8 @@
 
 from alembic import op
 import sqlalchemy as sa
-import models
-from models import users  # noqa
-
+from app import models  # noqa
+from app.models import users # noqa
 
 # revision identifiers, used by Alembic.
 revision: str = "45f7c66353f4"

app.py → app/app.py

@@ -7,15 +7,15 @@
 from fastapi.exceptions import RequestValidationError
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import JSONResponse
-from routes.users import user
+from app.routes import user
 from fastapi_pagination import add_pagination
-from middlewares.rate_limiter_middleware import RateLimitMiddleware
-from middlewares.request_id_injection import RequestIdInjection
+from app.middlewares.rate_limiter_middleware import RateLimitMiddleware
+from app.middlewares.request_id_injection import RequestIdInjection
 from pybreaker import CircuitBreakerError
 from dependencies import circuit_breaker
-from utils.slack_notification_utils import send_slack_message
+from app.utils.slack_notification_utils import send_slack_message
 import traceback
-from middlewares.request_id_injection import request_id_contextvar
+from app.middlewares.request_id_injection import request_id_contextvar
 
 # Initializing the swagger docs
 app = FastAPI(

app/config/__init__.py

@@ -0,0 +1,11 @@
+from .config import get_secret_key
+from .db import create_local_session, engine
+from .redis_config import get_redis_pool
+
+
+__all__ = [
+    "get_secret_key",
+    "create_local_session",
+    "engine",
+    "get_redis_pool",
+]

constants/jwt_utils.py → app/constants/jwt_utils.py

@@ -1,7 +1,7 @@
 from fastapi import HTTPException
 import jwt
 import datetime
-from config.config import get_secret_key
+from app.config.config import get_secret_key
 
 
 def create_access_token(data: dict):

app/daos/__init__.py

@@ -0,0 +1,3 @@
+from .users import get_user, list_users, create_user, login
+
+__all__ = ["get_user", "list_users", "create_user", "login"]

daos/users.py → app/daos/users.py

@@ -2,17 +2,15 @@
 from aioredis import Redis
 from fastapi import HTTPException
 from sqlalchemy.orm import Session
-from constants import jwt_utils
-from constants.messages.users import user_messages as messages
-from models.users import User
-from schemas.users import CreateUser
-from schemas.users import Login
-from schemas.users import UserOutResponse
+from app.constants import jwt_utils
+from app.constants.messages.users import user_messages as messages
+from app.models import User
+from app.schemas import CreateUser, UserOutResponse, Login
 from werkzeug.security import check_password_hash
 from fastapi_pagination.ext.sqlalchemy import paginate
 from sqlalchemy import select
-from utils import redis_utils
-from utils.user_utils import check_existing_field, responseFormatter
+from app.utils import redis_utils
+from app.utils.user_utils import check_existing_field, responseFormatter
 
 
 def get_user(user_id: int, dbSession: Session):

app/models/__init__.py

@@ -0,0 +1,13 @@
+# import glob
+# from os.path import basename
+# from os.path import dirname
+# from os.path import isfile
+# from os.path import join
+
+# modules = glob.glob(join(dirname(__file__), "*.py"))
+
+# __all__ = [basename(f)[:-3] for f in modules if isfile(f) and not f.endswith("__init__.py")]
+
+from .users import User
+
+__all__ = ["User"]

models/users.py → app/models/users.py

@@ -7,7 +7,7 @@
 from werkzeug.security import generate_password_hash
 from sqlalchemy import event
 
-from config.db import engine
+from app.config.db import engine
 
 Base = declarative_base()
 

app/routes/__init__.py

@@ -0,0 +1,3 @@
+from .users import user
+
+__all__ = ["user"]

routes/users.py → app/routes/users.py

@@ -2,20 +2,20 @@
 from fastapi import Depends
 from sqlalchemy.orm import Session
 from fastapi_pagination import Page
-from config.db import create_local_session
-from daos.users import create_user as create_user_dao
-from daos.users import get_user as get_user_dao
-from daos.users import list_users as list_users_dao
-from daos.users import login as signin
-from models.users import User
-from schemas.users import CreateUser
-from schemas.users import UserOutResponse
-from schemas.users import Login
-from utils.redis_utils import get_redis
-from utils.user_utils import get_current_user
+from app.config.db import create_local_session
+from app.daos import (
+    create_user as create_user_dao,
+    get_user as get_user_dao,
+    list_users as list_users_dao,
+    login as signin,
+)
+from app.models import User
+from app.schemas import CreateUser, UserOutResponse, Login
+from app.utils.redis_utils import get_redis
+from app.utils.user_utils import get_current_user
 from typing import Annotated
 from fastapi.security import HTTPBearer
-from middlewares.request_id_injection import request_id_contextvar
+from app.middlewares.request_id_injection import request_id_contextvar
 
 user = APIRouter()
 

app/schemas/__init__.py

@@ -0,0 +1,3 @@
+from .users import CreateUser, Login, UserOutResponse
+
+__all__ = ["CreateUser", "Login", "UserOutResponse"]

schemas/users.py → app/schemas/users.py

@@ -1,6 +1,6 @@
 import re
 
-from constants.messages.users import user_messages as messages
+from app.constants.messages.users import user_messages as messages
 from fastapi import HTTPException
 from pydantic import BaseModel
 from pydantic import validator

utils/redis_utils.py → app/utils/redis_utils.py

@@ -1,4 +1,4 @@
-from config.redis_config import get_redis_pool
+from app.config.redis_config import get_redis_pool
 
 
 async def get_redis():

utils/user_utils.py → app/utils/user_utils.py

@@ -1,7 +1,7 @@
 from fastapi import HTTPException
 from sqlalchemy.orm import Session
 from fastapi import Request, HTTPException
-from constants import jwt_utils
+from app.constants import jwt_utils
 from fastapi import HTTPException
 
 

scripts/local_server.sh

@@ -1,2 +1,2 @@
 # Run migrations and start server
-alembic upgrade head && uvicorn app:app --host 0.0.0.0 --port 8000
+alembic upgrade head && uvicorn app.app:app --host 0.0.0.0 --port 8000