51 lines (36 loc) · 1.08 KB

📡 SensorsAPI

Python Async RESTful API built using FastAPI and Tortoise ORM, designed to manage sensor data with PostgreSQL database.

📦 DB Structure:

❇️ Key features:

FastAPI async RESTful API 📄
Tortoise ORM async transactional PostgreSQL management 🗄
Docker and Docker Compose easy deployment 🚚
Pydantics models fields verification 🖊
OAuth2 user authentication 🔑
Argon2 passwords encryption 🔒
Docker container healthcheck ❤️
PyTest automatic tests with mock SQLite3 database ✅
Extended searching options by parameters for GET requests 🔎
Preview shared devices and their children 🔗

🛂 Requirements:

Internet connection (to build) 📶
Docker 📦
Docker Compose 🚛
WSL and Docker Desktop (on Windows) 💻

⚙️ Build and run

Set environmental variables:

DB_NAME
DB_USER
DB_PASSWORD
JWT_SECRET

Run command:

docker compose up

✅ Testing and Coverage

Run this command inside docker container:

pytest --cov=.