initial setup correct

Pipfile

@@ -5,7 +5,6 @@ name = "pypi"
 
 [packages]
 fastapi = "*"
-uvicorn = {extras = ["standard"], version = "*"}
 python-dotenv = "*"
 sqlalchemy = "*"
 psycopg2-binary = "*"
@@ -13,6 +12,7 @@ pytest = "*"
 pytest-cov = "*"
 faker = "*"
 requests-mock = "*"
+uvicorn = {extras = ["standard"], version = "*"}
 
 [dev-packages]
 

README.md

@@ -1,11 +1,11 @@
-# my-fastapi-project
+# whisper.api
 
 This is a production level project structure for a Python FastAPI project.
 
 ## Project Structure
 
 ```
-my-fastapi-project
+whisper.api
 ├── app
 │   ├── __init__.py
 │   ├── api
@@ -67,4 +67,11 @@ The project structure is organized as follows:
 - `Dockerfile`: specifies the Docker image configuration.
 - `requirements.txt`: specifies the Python dependencies.
 - `README.md`: this file.
-- `.vscode`: contains Visual Studio Code configuration files.
+- `.vscode`: contains Visual Studio Code configuration files.
+
+
+## Run this Project
+
+```bash
+uvicorn app.main:app --reload
+```

app/__init__.py

@@ -1,6 +1,6 @@
 from fastapi import FastAPI
 
-from app.api.api import api_router
+from app.api import api_router
 from app.core.config import settings
 
 

app/api/__init__.py

@@ -1,10 +1,9 @@
-# File: my-fastapi-project/app/api/__init__.py
+# File: whisper.api/app/api/__init__.py
 
-from fastapi import FastAPI
+from fastapi import APIRouter
 from .endpoints import items, users
-from .models import item, user
 
-app = FastAPI()
+api_router = APIRouter()
 
-app.include_router(items.router)
-app.include_router(users.router)
+api_router.include_router(items.router, prefix="/items", tags=["items"])
+api_router.include_router(users.router, prefix="/users", tags=["users"])

app/api/endpoints/__init__.py

@@ -1,4 +1,4 @@
-# File: my-fastapi-project/app/api/endpoints/__init__.py
+# File: whisper.api/app/api/endpoints/__init__.py
 
 from fastapi import APIRouter
 

app/api/endpoints/users.py

@@ -1,12 +1,14 @@
 from fastapi import APIRouter
 
 from app.api.models.user import UserInDB
-from app.api.db import database
+from app.core.database import SessionLocal
 
-users_router = r = APIRouter()
+database = SessionLocal()
 
+users_router = router = APIRouter()
 
-@r.post("/", response_model=UserInDB, status_code=201)
+
+@router.post("/", response_model=UserInDB, status_code=201)
 async def create_user(user: UserInDB):
     query = UserInDB.insert().values(
         username=user.username,
@@ -17,14 +19,14 @@ async def create_user(user: UserInDB):
     return {**user.dict(), "id": user_id}
 
 
-@r.get("/{id}/", response_model=UserInDB)
+@router.get("/{id}/", response_model=UserInDB)
 async def read_user(id: int):
     query = UserInDB.select().where(UserInDB.c.id == id)
     user = await database.fetch_one(query)
     return user
 
 
-@r.put("/{id}/", response_model=UserInDB)
+@router.put("/{id}/", response_model=UserInDB)
 async def update_user(id: int, user: UserInDB):
     query = (
         UserInDB
@@ -41,7 +43,7 @@ async def update_user(id: int, user: UserInDB):
     return {**user.dict(), "id": user_id}
 
 
-@r.delete("/{id}/", response_model=int)
+@router.delete("/{id}/", response_model=int)
 async def delete_user(id: int):
     query = UserInDB.delete().where(UserInDB.c.id == id)
     user_id = await database.execute(query)

app/api/models/item.py

@@ -13,7 +13,4 @@ class ItemCreate(ItemBase):
 
 class Item(ItemBase):
     id: int
-    owner_id: int
-
-    class Config:
-        orm_mode = True
+    owner_id: int

app/api/models/user.py

@@ -10,5 +10,5 @@ class User(UserBase):
     id: int
     is_active: bool
 
-    class Config:
-        orm_mode = True
+class UserInDB(User):
+    hashed_password: str

app/core/config.py

@@ -1,18 +1,24 @@
 from typing import Any, Dict, List, Optional, Union
-from pydantic import AnyHttpUrl, BaseSettings, validator
+from pydantic import AnyHttpUrl, validator
 
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from os import environ as env
 
 class Settings(BaseSettings):
     API_V1_STR: str = "/api/v1"
     PROJECT_NAME: str = "Whisper API"
-    SECRET_KEY: str
-    ACCESS_TOKEN_EXPIRE_MINUTES: int = 60
-    SERVER_NAME: str
-    SERVER_HOST: AnyHttpUrl
-    POSTGRES_SERVER: str
-    POSTGRES_USER: str
-    POSTGRES_PASSWORD: str
-    POSTGRES_DB: str
+    PROJECT_VERSION: str = "0.1.0"
+    SECRET_KEY: str = env.get("SECRET_KEY")
+    ACCESS_TOKEN_EXPIRE_MINUTES: int = env.get("ACCESS_TOKEN_EXPIRE_MINUTES")
+    SERVER_NAME: str = env.get("SERVER_NAME")
+    SERVER_HOST: AnyHttpUrl = env.get("SERVER_HOST")
+    POSTGRES_SERVER: str = env.get("POSTGRES_SERVER")
+    POSTGRES_USER: str = env.get("POSTGRES_USER")
+    POSTGRES_PASSWORD: str = env.get("POSTGRES_PASSWORD")
+    POSTGRES_DB: str = env.get("POSTGRES_DB")
+    POSTGRES_DATABASE_URL: str = env.get("POSTGRES_DATABASE_URL")
+    BACKEND_CORS_ORIGINS: List[AnyHttpUrl] = ['http://localhost:3000']
 
     @validator("SECRET_KEY", pre=True)
     def secret_key_must_be_set(cls, v: Optional[str], values: Dict[str, Any]) -> str:
@@ -56,5 +62,12 @@ class Settings(BaseSettings):
             raise ValueError("POSTGRES_DB must be set")
         return v
 
+    @validator("POSTGRES_DATABASE_URL", pre=True)
+    def postgres_db_url_must_be_set(cls, v: Optional[str], values: Dict[str, Any]) -> str:
+        if not v:
+            raise ValueError("POSTGRES_DATABASE_URL must be set")
+        return v
+
+
 
 settings = Settings()

app/core/database.py

@@ -4,7 +4,7 @@ from sqlalchemy.orm import sessionmaker
 
 from app.core.config import settings
 
-SQLALCHEMY_DATABASE_URL = settings.database_url
+SQLALCHEMY_DATABASE_URL = settings.POSTGRES_DATABASE_URL
 
 engine = create_engine(SQLALCHEMY_DATABASE_URL)
 

app/core/errors.py

@@ -0,0 +1,31 @@
+from fastapi import Request
+from fastapi.responses import JSONResponse
+from fastapi.exceptions import HTTPException , RequestValidationError
+
+async def http_exception_handler(request: Request, exc: HTTPException):
+    """
+    Exception handler for HTTP errors
+    """
+    return JSONResponse(
+        status_code=exc.status_code,
+        content={"message": exc.detail},
+    )
+
+async def http_error_handler(request: Request, exc: HTTPException):
+    """
+    Exception handler for HTTP errors
+    """
+    return JSONResponse(
+        status_code=exc.status_code,
+        content={"message": exc.detail},
+    )
+
+
+def http422_error_handler(request: Request, exc: RequestValidationError):
+    """
+    Exception handler for HTTP 422 errors
+    """
+    return JSONResponse(
+        status_code=422,
+        content={"message": "Validation error", "details": exc.errors()},
+    )

app/core/security.py

@@ -4,4 +4,17 @@ pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
 
 ALGORITHM = "HS256"
 ACCESS_TOKEN_EXPIRE_MINUTES = 30
-SECRET_KEY = "mysecretkey"
+SECRET_KEY = "mysecretkey"
+
+
+def get_password_hash(password: str) -> str:
+    """
+    Hashes a password using bcrypt algorithm
+    """
+    return pwd_context.hash(password)
+
+def verify_password(password: str, hash: str) -> bool:
+    """
+    Verifies a password against a bcrypt hash
+    """
+    return pwd_context.verify(password, hash)

app/main.py

@@ -1,5 +1,5 @@
 from fastapi import FastAPI
-from app.api.api_v1.api import router as api_router
+from app.api import api_router
 from app.core.config import settings
 from app.core.errors import http_error_handler
 from app.core.errors import http422_error_handler

app/tests/__init__.py

@@ -1,4 +1,4 @@
-# File: my-fastapi-project/app/tests/__init__.py
+# File: whisper.api/app/tests/__init__.py
 
 # Import necessary modules
 import pytest

app/tests/test_api/__init__.py

@@ -1,4 +1,4 @@
-# File: my-fastapi-project/app/tests/test_api/__init__.py
+# File: whisper.api/app/tests/test_api/__init__.py
 
 from fastapi.testclient import TestClient
 from my_fastapi_project.app.api import app

requirements.txt

@@ -6,4 +6,5 @@ psycopg2-binary
 pytest
 pytest-cov
 faker
-requests-mock
+requests-mock
+passlib