project structure and database

.env.example

@@ -0,0 +1,7 @@
+PG_LOGIN=
+PG_PASSWORD=
+PG_PORT=
+PG_DATABASE=
+PG_HOST=
+
+SECRET_KEY=

.gitignore

@@ -1,3 +1,10 @@
-.idea
+/migrations/versions/*
 .env
 .venv
+.idea
+__pycache__
+/venv
+/test
+/test/*
+certs
+.vscode

alembic.ini

@@ -0,0 +1,147 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts.
+# this is typically a path given in POSIX (e.g. forward slashes)
+# format, relative to the token %(here)s which refers to the location of this
+# ini file
+script_location = %(here)s/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
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# 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.  for multiple paths, the path separator
+# is defined by "path_separator" below.
+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 `alembic[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 <script_location>/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 "path_separator"
+# below.
+# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
+
+# path_separator; This indicates what character is used to split lists of file
+# paths, including version_locations and prepend_sys_path within configparser
+# files such as alembic.ini.
+# The default rendered in new alembic.ini files is "os", which uses os.pathsep
+# to provide os-dependent path splitting.
+#
+# Note that in order to support legacy alembic.ini files, this default does NOT
+# take place if path_separator is not present in alembic.ini.  If this
+# option is omitted entirely, fallback logic is as follows:
+#
+# 1. Parsing of the version_locations option falls back to using the legacy
+#    "version_path_separator" key, which if absent then falls back to the legacy
+#    behavior of splitting on spaces and/or commas.
+# 2. Parsing of the prepend_sys_path option falls back to the legacy
+#    behavior of splitting on spaces, commas, or colons.
+#
+# Valid values for path_separator are:
+#
+# path_separator = :
+# path_separator = ;
+# path_separator = space
+# path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+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
+
+# database URL.  This is consumed by the user-maintained env.py script only.
+# other means of configuring database URLs may be customized within the env.py
+# file.
+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 module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration.  This is also consumed by the user-maintained
+# env.py script only.
+[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

backend/config.py

@@ -0,0 +1,14 @@
+import os
+
+from dotenv import load_dotenv
+
+load_dotenv()
+
+# Database
+PG_LOGIN = os.environ.get("PG_LOGIN")
+PG_PASSWORD = os.environ.get("PG_PASSWORD")
+PG_PORT = os.environ.get("PG_PORT")
+PG_DATABASE = os.environ.get("PG_DATABASE")
+PG_HOST = os.environ.get("PG_HOST")
+
+SECRET_KEY = os.environ.get("SECRET_KEY")

backend/dependecies.py

@@ -0,0 +1,11 @@
+from typing import Annotated
+
+from fastapi import Depends
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from backend.session import get_session
+from schemas.base import PaginationSchema
+from utils.pagination import pagination_parameters
+
+SessionDependency = Annotated[AsyncSession, Depends(get_session)]
+PaginationDependency = Annotated[PaginationSchema, Depends(pagination_parameters)]

backend/session.py

@@ -0,0 +1,21 @@
+from typing import AsyncGenerator
+
+from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession
+from sqlalchemy.orm import sessionmaker
+
+from .config import PG_DATABASE, PG_HOST, PG_PASSWORD, PG_LOGIN
+
+DATABASE_URL = f"postgresql+asyncpg://{PG_LOGIN}:{PG_PASSWORD}@{PG_HOST}/{PG_DATABASE}"
+engine = create_async_engine(DATABASE_URL)
+session_maker = sessionmaker(
+    engine,
+    class_=AsyncSession,
+    expire_on_commit=False,
+    autocommit=False,
+    autoflush=False,
+)
+
+
+async def get_session() -> AsyncGenerator[AsyncSession, None]:
+    async with session_maker() as session:
+        yield session

constants.py

@@ -0,0 +1,13 @@
+import os
+import sys
+
+DOMAIN_NAME = "crm.logidex.ru"
+API_ROOT = "/api"
+
+APP_PATH = (
+    os.path.dirname(sys.executable)
+    if getattr(sys, "frozen", False)
+    else os.path.dirname(__file__)
+)
+
+STATIC_PATH = os.path.join(APP_PATH, "static")

main.py

@@ -1,13 +1,22 @@
 from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from starlette.staticfiles import StaticFiles
 
-app = FastAPI()
+origins = [
+    'http://localhost:5173'
+]
+
+app = FastAPI(separate_input_output_schemas=False)
 
 
-@app.get("/")
+app.add_middleware(
-async def root():
+    CORSMiddleware,
-    return {"message": "Hello World"}
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
 
+routers_list = []
 
-@app.get("/hello/{name}")
+app.mount("/static", StaticFiles(directory="static"), name="static")
-async def say_hello(name: str):
-    return {"message": f"Hello {name}"}

migrate.sh

@@ -0,0 +1,2 @@
+alembic revision --autogenerate
+alembic upgrade head

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration with an async dbapi.

migrations/env.py

@@ -0,0 +1,103 @@
+import asyncio
+import backend.config as settings
+from logging.config import fileConfig
+
+from sqlalchemy.engine import Connection
+
+from alembic import context
+from backend.session import engine
+from models.base import BaseModel
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = BaseModel.metadata
+
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+def include_object(object, name, type_, reflected, compare_to):
+    return True  # Temporarily return True to debug all objects
+
+
+def get_url():
+    url = config.get_main_option("sqlalchemy.url").format(
+        PG_LOGIN=settings.PG_LOGIN,
+        PG_PASSWORD=settings.PG_PASSWORD,
+        PG_HOST=settings.PG_HOST,
+        PG_DATABASE=settings.PG_DATABASE,
+    )
+    return url
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def do_run_migrations(connection: Connection) -> None:
+    context.configure(
+        connection=connection,
+        target_metadata=target_metadata,
+        include_schemas=True,
+        include_object=include_object,
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+async def run_async_migrations() -> None:
+    """
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+    """
+    connectable = engine
+
+    async with connectable.connect() as connection:
+        await connection.run_sync(do_run_migrations)
+
+    await connectable.dispose()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode."""
+
+    asyncio.run(run_async_migrations())
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migrations/script.py.mako

@@ -0,0 +1,28 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    """Upgrade schema."""
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    ${downgrades if downgrades else "pass"}

models/base.py

@@ -0,0 +1,12 @@
+from sqlalchemy.ext.asyncio import AsyncAttrs
+from sqlalchemy.orm import DeclarativeBase
+
+
+class BaseModel(DeclarativeBase, AsyncAttrs):
+    def __repr__(self):
+        if hasattr(self, 'id'):
+            return f'<{self.__class__.__name__} id={self.id}>'
+        return super().__repr__()
+
+
+metadata = BaseModel.metadata

requirements.txt

@@ -0,0 +1,18 @@
+# FastApi
+fastapi
+pydantic
+uvicorn
+uvicorn[standard]
+gunicorn
+python-multipart
+starlette
+
+# Database
+sqlalchemy
+sqlalchemy[asyncio]
+asyncpg
+alembic
+
+# Other
+python-dotenv
+ruff

ruff.toml

@@ -32,8 +32,8 @@ exclude = [
 line-length = 88
 indent-width = 4
 
-# Assume Python 3.9
+# Assume Python 3.13
-target-version = "py39"
+target-version = "py313"
 
 [lint]
 # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.

schemas/base.py

@@ -0,0 +1,55 @@
+from typing import Self
+
+from pydantic import BaseModel
+from pydantic.alias_generators import to_camel
+
+
+class CustomConfig:
+    populate_by_name = True
+    from_attributes = True
+
+
+class BaseSchema(BaseModel):
+    class Config:
+        from_attributes = True
+        alias_generator = to_camel
+        populate_by_name = True
+
+    @classmethod
+    def from_sql_model(cls, model, fields: dict):
+        model_dict = {c.name: getattr(model, c.name) for c in model.__table__.columns}
+        model_dict.update(fields)
+        return cls(**model_dict)
+
+    def model_dump_parent(self):
+        parent_class: BaseModel = self.__class__.__bases__[0]
+        parent_fields = set(parent_class.model_fields.keys())
+        return self.model_dump(include=parent_fields)
+
+    @classmethod
+    def from_orm_list(cls, sql_models) -> list[Self]:
+        return [cls.model_validate(model) for model in sql_models]
+
+
+class OkMessageSchema(BaseSchema):
+    ok: bool
+    message: str
+
+
+class PaginationSchema(BaseSchema):
+    page: int | None = None
+    items_per_page: int | None = None
+
+
+class PaginationInfoSchema(BaseSchema):
+    total_pages: int
+    total_items: int
+
+
+class BaseEnumSchema(BaseSchema):
+    id: int
+    name: str
+
+
+class BaseEnumListSchema(BaseSchema):
+    items: list[BaseEnumSchema]

utils/pagination.py

@@ -0,0 +1,15 @@
+from schemas.base import PaginationSchema
+
+
+async def pagination_parameters(
+    page: int | None = None, items_per_page: int | None = None
+) -> PaginationSchema:
+    return PaginationSchema(page=page, items_per_page=items_per_page)
+
+
+def is_valid_pagination(pagination: PaginationSchema | None) -> bool:
+    if not pagination:
+        return False
+    return all(
+        [isinstance(pagination.items_per_page, int), isinstance(pagination.page, int)]
+    )