Rework project architecture

Author: eugeneliukindev

.env

@@ -0,0 +1,7 @@
+# APP_CONFIG__DB__URL=postgresql+asyncpg://user:password@localhost:5432/db_name
+APP_CONFIG__DB__NAME=db_name
+APP_CONFIG__DB__PASSWORD=password
+APP_CONFIG__DB__USER=user
+APP_CONFIG__DB__HOST=localhost
+APP_CONFIG__DB__PORT=5432
+APP_CONFIG__DB__DRIVER=postgresql+asyncpg

.env-template

@@ -0,0 +1,5 @@
+APP_CONFIG__DB__URL=postgresql+asyncpg://user:password@localhost:5432/db_name
+APP_CONFIG__DB__ECHO=1
+APP_CONFIG__DB__ECHO_POOL=False
+APP_CONFIG__DB__POOL_SIZE=50
+APP_CONFIG__DB__MAX_OVERFLOW=10

alembic.ini

@@ -0,0 +1,123 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts.
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library.
+# Any required deps can installed by adding `migrations[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new migrations.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+# version_path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+version_path_separator = os
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+hooks = ruff
+ruff.type = exec
+# %(here)s/.venv/bin/ruff
+ruff.executable = %(here)s/.venv/bin/ruff
+ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+;hooks = pre_commit
+;pre_commit.type = console_scripts
+;pre_commit.entrypoint = pre-commit
+;pre_commit.options = run --files REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

app/__init__.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from fastapi import (
+    APIRouter,
+)
+
+from app.core.schemas import UserCreateS, UserPutS, UserS
+from app.core.schemas.user import UserPatchS
+from app.exceptions.users import raise_user_already_exists_exp, raise_user_not_found_exp
+from app.repository import UserService
+from app.utils.types import SessionDep
+
+if TYPE_CHECKING:
+    from typing import Any
+router = APIRouter(tags=["Users"], prefix="/users")
+
+
+@router.get("", response_model=list[UserS])
+async def get_all_users(
+    session: SessionDep,
+) -> Any:
+    users = await UserService.get_all(session=session)
+    return users
+
+
+@router.post("", response_model=UserS)
+async def create_user(
+    session: SessionDep,
+    user_create: UserCreateS,
+) -> Any:
+    user = await UserService.create(
+        session=session,
+        user_create=user_create,
+    )
+    if user is None:
+        raise_user_already_exists_exp()
+
+    return user
+
+
+@router.get("/{user_id}", response_model=UserS)
+async def get_user(
+    user_id: int,
+    session: SessionDep,
+) -> Any:
+    user = await UserService.get(session=session, user_id=user_id)
+    if user is None:
+        raise_user_not_found_exp()
+    return user
+
+
+@router.put("/{user_id}", response_model=UserS)
+async def update_user_partial(
+    session: SessionDep,
+    user_id: int,
+    user_put: UserPutS,
+) -> Any:
+    updated_user = await UserService.update(
+        session=session, user_id=user_id, user_update=user_put
+    )
+    if updated_user is None:
+        raise_user_not_found_exp()
+    return updated_user
+
+
+@router.patch("/{user_id}", response_model=UserS)
+async def update_user(
+    session: SessionDep,
+    user_id: int,
+    user_patch: UserPatchS,
+) -> Any:
+    updated_user = await UserService.update(
+        session=session,
+        user_id=user_id,
+        user_update=user_patch,
+    )
+    if updated_user is None:
+        raise_user_not_found_exp()
+    return updated_user
+
+
+@router.delete("/{user_id}", response_model=UserS)
+async def delete_user(
+    session: SessionDep,
+    user_id: int,
+) -> Any:
+    deleted_user = await UserService.delete(session=session, user_id=user_id)
+    if deleted_user is None:
+        raise_user_not_found_exp()
+    return deleted_user

app/api/__init__.py

@@ -0,0 +1,12 @@
+from fastapi import APIRouter
+
+from app.api.v1.endpoints.users import router as user_router
+
+api_v1_router = APIRouter(prefix="/v1")
+
+router_list = [
+    user_router,
+]
+
+for r in router_list:
+    api_v1_router.include_router(r)