а-ля-я тесты и аля рефакторинг

Author: ProFastCode

.env.dist

@@ -3,8 +3,9 @@ APP_TITLE="FastAPI Template"
 APP_VERSION="1.0.0"
 APP_SECRET_KEY="123abc"
 
-POSTGRES_DB="postgres"
-POSTGRES_HOST="postgres"
-POSTGRES_PORT=5432
-POSTGRES_USER="postgres"
-POSTGRES_PASSWORD="postgres"
+DB="postgres"
+DB_HOST="postgres"
+DB_PORT=5432
+DB_USER="postgres"
+DB_PASSWORD="postgres"
+DB_DRIVERNAME="postgresql+asyncpg"

.github/workflows/generate-swagger-and-commit-to-docs.yml

@@ -1,75 +1,20 @@
-# FastAPI
-
-## File Structure
-```
-.
-├── __init__.py
-├── api
-│   ├── __init__.py
-│   ├── deps.py
-│   └── v1
-│       ├── __init__.py
-│       ├── auth
-│       │   ├── __init__.py
-│       │   └── token.py
-│       └── users
-│           ├── __init__.py
-│           ├── create.py
-│           └── retrieve.py
-├── core
-│   ├── __init__.py
-│   ├── db.py
-│   ├── exps.py
-│   └── settings.py
-├── logic
-│   ├── __init__.py
-│   ├── auth
-│   │   ├── __init__.py
-│   │   └── auth.py
-│   ├── logic.py
-│   ├── security
-│   │   ├── __init__.py
-│   │   ├── jwt.py
-│   │   ├── pwd.py
-│   │   └── security.py
-│   └── users
-│       ├── __init__.py
-│       └── users.py
-├── models
-│   ├── __init__.py
-│   ├── auth
-│   │   ├── __init__.py
-│   │   └── token.py
-│   ├── base.py
-│   ├── types
-│   │   ├── __init__.py
-│   │   └── unix.py
-│   └── users
-│       ├── __init__.py
-│       └── user.py
-└── repositories
-    ├── __init__.py
-    ├── base.py
-    └── user.py
+# FastAPI
 
-14 directories, 34 files
-```
+## Create a `.env` file based on `.env.dist` and make all the necessary customizations
 
-## Create a `.env` file based on `.env.dist` and make all the necessary customizations
-
-### To run the application in a docker container, run the command
-
-`docker-compose up -d`
-
-### To run the application without a docker container, complete follow these steps
-
-1. Install dependencies.
-
-    `poetry install` or `pip install -r requirements.txt`
-2. Run application.
-
-    `poetry run fastapi dev app` or `make dev`
-
-### Make documentation
-
-`make help`
+### To run the application in a docker container, run the command
+
+`docker-compose up -d`
+
+### To run the application without a docker container, complete follow these steps
+
+1. Install dependencies.
+
+    `poetry install` or `pip install -r requirements.txt`
+2. Run application.
+
+    `poetry run fastapi dev app` or `make dev`
+
+### Make documentation
+
+`make help`

.github/workflows/get-tree-and-commit-to-readme.yml

@@ -8,7 +8,7 @@
 from fastapi.security import APIKeyHeader
 
 from app.logic import Logic as _Logic
-from app.models.users.user import User as _User
+from app.models.users import User as _User
 
 
 async def get_logic() -> AsyncGenerator[_Logic, None]:

.github/workflows/reformat-code-and-commit.yml

@@ -2,7 +2,7 @@
 
 from app.api import deps
 from app.models.auth import AccessToken
-from app.models.users.user import UserCreate
+from app.models.users import UserCreate
 
 router = APIRouter(prefix='/token')
 

README.md

@@ -1,7 +1,7 @@
 from fastapi import APIRouter
 
 from app.api import deps
-from app.models.users.user import UserCreate, UserRead
+from app.models.users import UserCreate, UserRead
 
 router = APIRouter(prefix='/create')
 

app/api/deps.py

@@ -5,7 +5,7 @@
 from fastapi import APIRouter
 
 from app.api import deps
-from app.models.users.user import UserRead
+from app.models.users import UserRead
 
 router = APIRouter()
 

app/api/v1/auth/token.py

@@ -24,7 +24,7 @@ def __init__(
     async def __set_async_engine(self) -> None:
         if self.__engine is None:
             self.__engine = create_async_engine(
-                settings.pg_dsn.unicode_string(), echo=False, future=True
+                settings.db_dsn, echo=False, future=True
             )
 
     async def __set_async_session(self) -> None:

app/api/v1/users/create.py

@@ -2,38 +2,39 @@
 Settings
 """
 
-from pydantic import PostgresDsn
 from pydantic_settings import BaseSettings, SettingsConfigDict
+from sqlalchemy import URL
 
 
 class Settings(BaseSettings):
     model_config = SettingsConfigDict(
-        env_file='.env', env_file_encoding='utf-8', case_sensitive=True
+        env_file=".env", env_file_encoding="utf-8", case_sensitive=True
     )
 
     # APP
-    APP_PATH: str = '/api'
-    APP_TITLE: str = 'FastAPI Template'
-    APP_VERSION: str = 'beta'
-    APP_SECRET_KEY: str = 'abc'
+    APP_PATH: str = "/api"
+    APP_TITLE: str = "FastAPI Template"
+    APP_VERSION: str = "beta"
+    APP_SECRET_KEY: str = "abc"
 
     # DATABASE
-    POSTGRES_DB: str = 'postgres'
-    POSTGRES_HOST: str = '127.0.0.1'
-    POSTGRES_PORT: int = 5432
-    POSTGRES_USER: str = 'postgres'
-    POSTGRES_PASSWORD: str = 'postgres'
+    DB: str = "postgres"
+    DB_HOST: str = "localhost"
+    DB_PORT: int = 5432
+    DB_USER: str = ""
+    DB_PASSWORD: str = ""
+    DB_DRIVERNAME: str = "postgresql+asyncpg"
 
     @property
-    def pg_dsn(self) -> PostgresDsn:
-        return PostgresDsn.build(
-            scheme='postgresql+asyncpg',
-            username=self.POSTGRES_USER,
-            password=self.POSTGRES_PASSWORD,
-            host=self.POSTGRES_HOST,
-            port=self.POSTGRES_PORT,
-            path=self.POSTGRES_DB,
-        )
+    def db_dsn(self) -> str:
+        return URL.create(
+            drivername=self.DB_DRIVERNAME,
+            username=self.DB_USER,
+            password=self.DB_PASSWORD,
+            host=self.DB_HOST,
+            port=self.DB_PORT,
+            database=self.DB,
+        ).render_as_string(hide_password=False)
 
 
 settings = Settings()

app/api/v1/users/retrieve.py

@@ -2,7 +2,7 @@
 
 from app.core import exps
 from app.models.auth import AccessToken
-from app.models.users.user import UserCreate
+from app.models.users import UserCreate
 
 if TYPE_CHECKING:
     from app.logic import Logic

app/core/db.py

@@ -17,6 +17,6 @@ def __init__(self, db: Database):
 
     @classmethod
     @asynccontextmanager
-    async def create(cls) -> AsyncGenerator['Logic', None]:
+    async def create(cls) -> AsyncGenerator["Logic", None]:
         async with Database() as db:
             yield cls(db)

app/core/settings.py

@@ -1,7 +1,7 @@
 from typing import TYPE_CHECKING
 
 from app.core import exps
-from app.models.users.user import User, UserCreate
+from app.models.users import User, UserCreate
 
 if TYPE_CHECKING:
     from app.logic import Logic

app/logic/auth/auth.py renamed to app/logic/auth.py

@@ -2,8 +2,6 @@
 Database Models Module
 """
 
-from . import users
+from . import auth, users
 
-__all__ = [
-    'users',
-]
+__all__ = ['users', 'auth']

app/logic/auth/__init__.py

@@ -36,6 +36,3 @@ class TimestampModel(SQLModel):
         nullable=True,
         sa_column_kwargs={'onupdate': datetime_utc_now},
     )
-
-    class Config:
-        arbitrary_types_allowed = True