For code review

.env.example

@@ -0,0 +1,5 @@
+DATABASE_URL=postgresql+asyncpg://postgres:postgres@localhost:5432/rest_api_db
+API_KEY=your-secret-api-key-here
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+POSTGRES_DB=rest_api_db

.pre-commit-config.yaml

@@ -34,3 +34,4 @@ repos:
     hooks:
       - id: mypy
         args: [--ignore-missing-imports, --check-untyped-defs]
+        exclude: ^(tests/|seed_data\.py)

Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.11-slim
+
+WORKDIR /app
+
+# Install poetry
+RUN pip install --no-cache-dir poetry==1.8.0
+
+# Copy dependency files
+COPY pyproject.toml poetry.lock* ./
+
+# Install dependencies
+RUN poetry config virtualenvs.create false && \
+    poetry install --no-interaction --no-ansi --no-root
+
+# Copy application code
+COPY . .
+
+# Expose port
+EXPOSE 8000
+
+# Run application
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000"]

README.md

@@ -0,0 +1,130 @@
+# REST API Application
+
+REST API приложение для управления справочником Организаций, Зданий и Деятельности.
+
+## Технологии
+
+- Python 3.11+
+- FastAPI
+- SQLAlchemy 2.x (async)
+- PostgreSQL
+- Alembic
+- Docker
+
+## Структура БД
+
+Схема базы данных представлена в файле `schema.png`.
+
+## Быстрый старт
+
+### С использованием Docker
+
+```bash
+docker-compose up -d
+```
+
+Приложение будет доступно по адресу: http://localhost:8000
+
+API документация (Swagger UI): http://localhost:8000/docs
+Альтернативная документация (ReDoc): http://localhost:8000/redoc
+
+### Локальная разработка
+
+1. Установите зависимости:
+```bash
+poetry install
+```
+
+2. Создайте файл `.env` на основе `.env.example`
+
+3. Запустите PostgreSQL
+
+4. Примените миграции:
+```bash
+poetry run alembic upgrade head
+```
+
+5. Запустите приложение:
+```bash
+poetry run uvicorn app.main:app --reload
+```
+
+## API Key
+
+Для доступа к API необходимо передавать API ключ в заголовке:
+```
+X-API-Key: your-api-key
+```
+
+По умолчанию (из .env): `test-api-key-12345`
+
+## Разработка
+
+### Установка dev зависимостей
+
+```bash
+poetry install --with dev
+```
+
+
+Теперь при каждом коммите будут автоматически запускаться линтеры.
+
+### Тестирование
+
+Проект использует **pytest** для тестирования.
+
+
+## Полезные команды
+
+```bash
+make help          # Показать все доступные команды
+make install       # Установить зависимости
+make test          # Запустить тесты
+make lint          # Проверить код линтерами
+make format        # Отформатировать код
+make clean         # Очистить кеш и временные файлы
+```
+
+## Миграции базы данных
+
+### Создание миграции
+
+```bash
+# Внутри Docker контейнера
+docker-compose exec app alembic revision --autogenerate -m "Migration description"
+
+# Локально
+poetry run alembic revision --autogenerate -m "Migration description"
+```
+
+### Применение миграций
+
+```bash
+# Внутри Docker контейнера
+docker-compose exec app alembic upgrade head
+
+# Локально
+poetry run alembic upgrade head
+```
+
+### Откат миграции
+
+```bash
+# На один шаг назад
+alembic downgrade -1
+
+# До конкретной версии
+alembic downgrade <revision>
+```
+
+## Тестовые данные
+
+Заполнить базу тестовыми данными:
+
+```bash
+# Внутри Docker
+docker-compose exec app python seed_data.py
+
+# Локально
+poetry run python seed_data.py
+```

alembic.ini

@@ -0,0 +1,150 @@
+# 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
+# Or organize into date-based subdirectories (requires recursive_version_locations = true)
+# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).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 tzdata library which can be 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
+# We use environment variables for DB connection (see migrations/env.py)
+
+
+[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

app/api/__init__.py

@@ -0,0 +1,3 @@
+from app.api import activities, buildings, organizations
+
+__all__ = ["organizations", "buildings", "activities"]