Бэкенд приложение для "Просепт" команды №13.
На текущий момент позволяет пользователям:
- загружать в базу данных информацию о дилерах, товарах производителя и товарах дилеров через удобный загрузчик;
- получать полный список всех товаров поставщика;
- получать список дилеров, а также id дилера в базе данных по его наименованию;
- получать список товаров дилеров, отфильтрованный по дате, дилеру или статусу (имеет установленное соответствие с товаром поставщика или еще нет);
- получать статистику по дилерам - какое количество товаров поставщика заведено в матрицу клиента и какое количество из них имеет установленное соответствие с товаром поставщика;
- создавать новый объект связи между товаром дилера и товаром поставщика.
- Python
- FastAPI
- PostgreSQL
- SQLAlchemy
- Docker
- Перечислены в файле prosept/requirements.txt
Могут быть найдены здесь.
- Установите на сервере
docker
иdocker compose
; - Склонируйте себе репозиторий:
git clone [email protected]:zhukov1414/prosept.git
- Перейдите в созданную папку:
cd prosept
- Создайте в корне проекта файл
.env
; Внесите в данный файл переменные окружения:
APP_TITLE=<название_Вашего_приложения>
DATABASE_URL=<postgresql+asyncpg://postgres:postgres@db:5432/postgres>
SECRET=<Ваш_секретный_ключ>
FIRST_SUPERUSER_EMAIL=<адрес_электронной_почты>
FIRST_SUPERUSER_PASSWORD=<произвольный_пароль>
POSTGRES_DB=<произвольное_имя_базы_данных>
POSTGRES_USER=<имя_пользователя_базы_данных>
POSTGRES_PASSWORD=<пароль_к_базе_данных>
DB_HOST=db
DB_PORT=<порт_базы_данных>
- Из корневой директории выполните команду
docker compose up -d --build
(возможно, придется выполнить данную команду дважды подряд, потому что одна из DS библиотек (nltk) ведет себя не хорошо, но совершенно необходима для работы);
После запуска контейнеров для того, чтобы наполнить базу данных, последовательно выполните команды (возможно потребуется прописать sudo)
docker compose exec backend python src/core/loader.py products src/data/marketing_product.csv
docker compose exec backend python src/core/loader.py dealers src/data/marketing_dealer.csv
docker compose exec backend python src/core/loader.py dealerprices src/data/marketing_dealerprice.csv
docker compose exec backend python src/core/loader.py productdealers src/data/marketing_productdealerkey.csv
- После этого Вам должна быть доступна страница с документацией http://localhost:8000/docs/.
В данной версии приложения, безопасность реализована рудиментарно: Вы можете получить JWT token обратившись по адресу /api/auth/jwt/login, но все эндпоинты доступны для всех желающих, без авторизации. Это можно изменить добавив параметр dependencies=[Depends(current_superuser)]
в корневой роутер, один из промежуточных роутеров или в любой из path декораторов, например, @router.get("/", response_model=list[DealerDb], dependencies=[Depends(current_superuser)], tags=["Main"])
.
Приложение полностью асинхронное (используются как асинхронные запросы, так и асинхронный драйвер базы данных), запускается в двух процессах, по одному на каждое физическое ядро процессора и потому отличается быстродействием.
Помимо этого можно включить (раскоментировав строчку # await scheduler() в функции lifespan в файле main.py) автоматический расчет предсказаний для товаров дилеров по расписанию ежедневно в 06:00. В данный момент функция отключена, т.к. требует для работы как минимум 3 Гб свободной оперативной памяти.