MH.Dmitrii/sqlalchemy-fastapi-pydentic-pytest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme 3.6

Browse Source
This commit is contained in:
Dmitrii Seliakov
2025-10-05 16:13:13 +03:00
parent 701bf5f603
commit a2aadc82b7
2 changed files with 21 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Plan
View File

@@ -1,7 +0,0 @@
###Приложение для мониторинга серверов###
#План: сделать сайт для отображения информации о системных компонентах
#Сделать авторизацию на нем с валидацией pydantic и создание пользователя с fastapi + sqlalchemy
#создать простую страничку с текстом по разным серверам
#придумать способ получать эти данные с серверов или хотяб со своей машины
#отправлять их так же вначале в fast-api, а он в бд и выводить будет на сайте
#Уведомлять по тг, если значения равын чему то

40
README.md
View File

@@ -8,12 +8,16 @@ Pet-проект на стеке **FastAPI + SQLAlchemy (async) + Pydantic + Pyt
## 📂 Структура проекта ## 📂 Структура проекта
``` ```
/ /
├── server/ # исходный код: модели, маршруты, JWT, базы данных ├── server/backend # Исходный код: endpoints, pydantic, JWT, отправка паролей на почту, permissions, rate-limiting
├── run.py # точка входа, запуск приложения ├── server/frontend # Странички login, registration, reset-password, main
├── requirements.txt # зависимости ├── server/database # База данных, alembic, db_balancer(не настроен, как шаблон)
├── .env # переменные окружения ├── server/testing # pytests
├── README.md # этот файл ├── run.py # Точка входа, запуск приложения
└── Plan # заметки / TODO / планы по проекту ├── makefile # Точка входа, запуск приложения и утилит
├── requirements.txt # Зависимости
├── .env # Переменные окружения
└── README.md # Этот файл
``` ```
--- ---
@@ -33,8 +37,8 @@ Pet-проект на стеке **FastAPI + SQLAlchemy (async) + Pydantic + Pyt
``` ```
2. Создать и активировать виртуальное окружение: 2. Создать и активировать виртуальное окружение:
``` ```
python3 -m venv venv python3 -m venv .venv
source venv/bin/activate # Linux / macOS source .venv/bin/activate # Linux / macOS
venv\Scripts\activate # Windows venv\Scripts\activate # Windows
``` ```
@@ -52,13 +56,16 @@ ALLOW_HEADERS=*
JWT_SECRET_KEY=your_secret_key JWT_SECRET_KEY=your_secret_key
ACCESS_TOKEN_EXPIRE_MINUTES=30 ACCESS_TOKEN_EXPIRE_MINUTES=30
``` ```
5. Мигрировать БД:
5. Запустить приложение:
``` ```
python run.py make migrate_head
```
6. Запустить приложение:
```
python run.py или вне окружения сразу прописать make run
``` ```
6. Документация OpenAPI будет доступна по адресу: 7. Документация OpenAPI будет доступна по адресу:
``` ```
• Swagger UI → http://localhost:8000/docs • Swagger UI → http://localhost:8000/docs
• JSON схема → http://localhost:8000/openapi.json • JSON схема → http://localhost:8000/openapi.json
@@ -93,9 +100,9 @@ username=<email>&password=<пароль>
Запуск всех тестов: Запуск всех тестов:
``` ```
pytest make test
``` ```
Тестируются: Тестируются (В планах):
``` ```
• CRUD операции • CRUD операции
• Pydantic-схемы • Pydantic-схемы
@@ -106,11 +113,6 @@ pytest
✅ TODO ✅ TODO
``` ```
• Миграции через Alembic
• Обработка ошибок ✅
• Логирование ✅
• PostgreSQL + Pgpool-II для продакшена ✅
• Разделение схем Pydantic на вход/выход ✅
• Тестирование edge-cases • Тестирование edge-cases
``` ```
⸻ ⸻