feat: implement core logic and tests

Author: volychev

.env.example

@@ -0,0 +1,9 @@
+# Common
+DEBUG=True
+
+# PostgreSQL
+POSTGRES_USER=
+POSTGRES_PASSWORD=
+POSTGRES_HOST=
+POSTGRES_PORT=
+POSTGRES_DATABASE=

README.md

@@ -1,21 +1,36 @@
-# python-template
-![Static Badge](https://img.shields.io/badge/Python-0?style=flat-square&logo=python&color=010409)
-![Static Badge](https://img.shields.io/badge/Poetry-0?style=flat-square&logo=Poetry&color=010409)
-![Static Badge](https://img.shields.io/badge/Docker-0?style=flat-square&logo=Docker&color=010409)
-![Static Badge](https://img.shields.io/badge/Flake8-0?style=flat-square&logo=Flake8&color=010409)
-![Static Badge](https://img.shields.io/badge/Black-0?style=flat-square&logo=Black&color=010409)
+# telemetry-api
+При разработке предлагается использовать Python версии не ниже 3.8, pip / poetry.
 
-Template for the [Python 3.13.11](https://www.python.org/downloads/release/python-3110/) projects based on [Poetry](https://python-poetry.org/docs/) using [Flake8](https://flake8.pycqa.org/en/latest/), [Black](https://black.readthedocs.io/en/stable/), [pre-commit](https://pre-commit.com/), [Docker](https://docs.docker.com/) and more
+## Примечания:
+- Пункты отмеченные "\*" необязательны к выполнению
+- Необходимо подготовить описание реализованного сервиса
+- Приложить результаты нагрузочного тестирования
+- Формат предоставления: ссылка на репозиторий с кодом
 
-## Quick Start:
-1. Create a repository using this template
-2. Clone the created repository with `git clone`
-3. Rename the created folder
-4. Go to the created folder
-5. Create a local environment using the command `poetry env use PYTHON_PATH` and add it to your IDE
-6. Rename the `python_template` folder to the project name and mark it in the IDE as `Source Root`
-7. Configure the `pyproject.toml` file for the project
-8. Configure the Flake8 linter and other required tools in the `setup.cfg` file
-9. Configure the `Dockerfile` for the project
-10. Configure and install pre-commits with the command `pre-commit install`
-11. Add the required dependencies with the command `poetry add PACKAGE_NAME` and install them with the command `poetry install`
+## Описание системы:
+К реализации предлагается система учета и анализа данных, поступающих с условного устройства. Полученные данные привязываются к временной метке и устройству, с которого пришли данные, и сохраняются в БД. Набор данных используется для дальнейшего анализа.
+
+## Требования к системе:
+
+### Функциональные:
+- В системе реализован сбор статистики с устройства по его идентификатору
+- формат получаемой статистики - {“x”: float, “y”: float, “z”:float}
+- В системе реализован анализ собранной статистики с устройства за определенный период и за все время
+- Результатами анализа являются числовые характеристики величины:
+  - минимальное значение
+  - максимальное значение
+  - количество
+  - сумма
+  - медиана
+- Система поддерживает добавление пользователей устройств*
+- В системе реализован функционал получения анализа показаний устройств по идентификатору пользователя*:
+  - агрегированные результаты для всех устройств
+  - для каждого устройства отдельно
+
+### Нефункциональные:
+- архитектура REST
+- фреймворк реализации сервиса FastApi
+- собранные данные хранятся в БД на выбор разработчика
+- аналитика показателей происходит в асинхронном режиме при помощи фреймворка Celery*
+- Реализовано нагрузочное тестирование через инструмент locust*
+- Сервис и его окружение разворачивается средствами docker + docker-compose

pyproject.toml

@@ -1,13 +1,22 @@
 [tool.poetry]
-name = "python-template"
+name = "telemetry-api"
 version = "0.0.0"
 description = ""
-authors = ["Your Name <you@example.com>"]
+authors = ["Kirill Volychev <volychevk@gmail.com>"]
 readme = "README.md"
-packages = [{include = "python_template"}]
+packages = [{include = "telemetry_api"}]
 
 [tool.poetry.dependencies]
 python = "^3.13.11"
+fastapi = "^0.136.1"
+uvicorn = "^0.46.0"
+sqlalchemy = "^2.0.49"
+pydantic = "^2.13.4"
+pydantic-settings = "^2.14.1"
+aiosqlite = "^0.22.1"
+asyncpg = "^0.31.0"
+greenlet = "^3.5.0"
+email-validator = "^2.3.0"
 
 [tool.poetry.group.dev.dependencies]
 black = "^25.1.0"
@@ -20,6 +29,9 @@ pep8-naming = "^0.14.1"
 reorder-python-imports = "^3.14.0"
 autoflake = "^2.3.1"
 setuptools = "^75.8.0"
+pytest = "^9.0.3"
+pytest-asyncio = "^1.3.0"
+httpx = "^0.28.1"
 
 [build-system]
 requires = ["poetry-core"]

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+asyncio_mode = auto
+pythonpath = .

python_template/__init__.py telemetry_api/__init__.pypython_template/__init__.py renamed to telemetry_api/__init__.py

@@ -0,0 +1,26 @@
+from fastapi import FastAPI
+
+from telemetry_api.api import analytics, devices, users
+
+
+def create_api() -> FastAPI:
+    """
+    Создание инстенса приложения с подключением всех роутеров
+
+    Return:
+        FastAPI - инстанс приложения
+    """
+
+    api = FastAPI(
+        title="Telemetry API",
+        description="",
+        version="1.0.0"
+    )
+
+    api.include_router(analytics.router)
+    api.include_router(devices.router)
+    api.include_router(users.router)
+    return api
+
+
+api = create_api()

telemetry_api/api/__init__.py

@@ -0,0 +1,28 @@
+from telemetry_api.database.database import get_db
+from telemetry_api.database.models import Measurement, Device
+from telemetry_api.schemas.analytics import MeasurementCreate, MeasurementRead
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.ext.asyncio import AsyncSession
+
+router = APIRouter(
+    prefix="/analytics",
+    tags=["Analytics"]
+)
+
+
+@router.post("/{device_id}/data", response_model=MeasurementRead, status_code=status.HTTP_201_CREATED)
+async def add_measurement(device_id: int, data: MeasurementCreate, db: AsyncSession = Depends(get_db)):
+    device = await db.get(Device, device_id)
+    if not device:
+        raise HTTPException(status_code=404, detail="Device not found")
+
+    new_measurement = Measurement(**data.model_dump(), device_id=device_id)
+    db.add(new_measurement)
+
+    await db.commit()
+    await db.refresh(new_measurement)
+    return new_measurement
+
+
+# TODO: analytics

telemetry_api/api/analytics.py

@@ -0,0 +1,59 @@
+from telemetry_api.database.database import get_db
+from telemetry_api.database.models import Device
+from telemetry_api.schemas.devices import DeviceCreate, DeviceRead, DeviceUpdate
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.ext.asyncio import AsyncSession
+from sqlalchemy import select
+
+router = APIRouter(prefix="/devices", tags=["Devices"])
+
+
+@router.post("/", response_model=DeviceRead, status_code=status.HTTP_201_CREATED)
+async def create_device(device_in: DeviceCreate, db: AsyncSession = Depends(get_db)):
+    new_device = Device(**device_in.model_dump())
+    db.add(new_device)
+
+    await db.commit()
+    await db.refresh(new_device)
+    return new_device
+
+
+@router.get("/{device_id}", response_model=DeviceRead)
+async def get_device(device_id: int, db: AsyncSession = Depends(get_db)):
+    device = await db.get(Device, device_id)
+    if not device:
+        raise HTTPException(status_code=404, detail="Device not found")
+    return device
+
+
+@router.patch("/{device_id}", response_model=DeviceRead)
+async def update_device(device_id: int, device_in: DeviceUpdate, db: AsyncSession = Depends(get_db)):
+    device = await db.get(Device, device_id)
+    if not device:
+        raise HTTPException(status_code=404, detail="Device not found")
+
+    update_data = device_in.model_dump(exclude_unset=True)
+    for key, value in update_data.items():
+        setattr(device, key, value)
+
+    await db.commit()
+    await db.refresh(device)
+    return device
+
+
+@router.delete("/{device_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_device(device_id: int, db: AsyncSession = Depends(get_db)):
+    device = await db.get(Device, device_id)
+    if not device:
+        raise HTTPException(status_code=404, detail="Device not found")
+
+    await db.delete(device)
+    await db.commit()
+    return None
+
+
+@router.get("/", response_model=list[DeviceRead])
+async def get_devices(limit: int = 25, offset: int = 0, db: AsyncSession = Depends(get_db)):
+    result = await db.execute(select(Device).offset(offset).limit(limit))
+    return result.scalars().all()

telemetry_api/api/devices.py

@@ -0,0 +1,62 @@
+from telemetry_api.database.database import get_db
+from telemetry_api.database.models import User
+from telemetry_api.schemas.users import UserCreate, UserRead, UserUpdate
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from sqlalchemy.ext.asyncio import AsyncSession
+from sqlalchemy import select
+
+router = APIRouter(
+    prefix="/users",
+    tags=["Users"]
+)
+
+
+@router.post("/", response_model=UserRead, status_code=status.HTTP_201_CREATED)
+async def create_user(user_in: UserCreate, db: AsyncSession = Depends(get_db)):
+    new_user = User(**user_in.model_dump())
+    db.add(new_user)
+
+    await db.commit()
+    await db.refresh(new_user)
+    return new_user
+
+
+@router.get("/{user_id}", response_model=UserRead)
+async def get_user(user_id: int, db: AsyncSession = Depends(get_db)):
+    user = await db.get(User, user_id)
+    if not user:
+        raise HTTPException(status_code=404, detail="User not found")
+    return user
+
+
+@router.patch("/{user_id}", response_model=UserRead)
+async def update_user(user_id: int, user_in: UserUpdate, db: AsyncSession = Depends(get_db)):
+    user = await db.get(User, user_id)
+    if not user:
+        raise HTTPException(status_code=404, detail="User not found")
+
+    update_data = user_in.model_dump(exclude_unset=True)
+    for key, value in update_data.items():
+        setattr(user, key, value)
+
+    await db.commit()
+    await db.refresh(user)
+    return user
+
+
+@router.delete("/{user_id}", status_code=status.HTTP_204_NO_CONTENT)
+async def delete_user(user_id: int, db: AsyncSession = Depends(get_db)):
+    user = await db.get(User, user_id)
+    if not user:
+        raise HTTPException(status_code=404, detail="User not found")
+
+    await db.delete(user)
+    await db.commit()
+    return None
+
+
+@router.get("/", response_model=list[UserRead])
+async def get_users(limit: int = 25, offset: int = 0, db: AsyncSession = Depends(get_db)):
+    result = await db.execute(select(User).offset(offset).limit(limit))
+    return result.scalars().all()

telemetry_api/api/users.py

@@ -0,0 +1,21 @@
+from pydantic_settings import BaseSettings, SettingsConfigDict
+from pydantic import SecretStr
+
+
+class Settings(BaseSettings):
+    debug: bool = False
+
+    postgres_user: SecretStr
+    postgres_password: SecretStr
+    postgres_host: SecretStr
+    postgres_port: int
+    postgres_database: SecretStr
+
+    model_config = SettingsConfigDict(
+        env_file=".env",
+        env_file_encoding="utf-8",
+        extra="ignore"
+    )
+
+
+config = Settings()