bdlg2023-sms-back/Readme.md

bdlg-2023-server

This repository host an API that can parse gsheet planning for brass dans la garonne event and manage creating automatic SMS notification for volunteer.

Getting started

For running the application

git clone ...
cd ...
python -m venv venv
venv/scripts/activate
poetry install

Note, be sure to use python3.11 with this application

• Copy .env.example to .env and edit it to configure your setup

init.sh
uvicorn app.main:app --reload

Debug

python -m app.debug

Run tests

pytest
pytest app\test\test_volunteer.py

Run coverage tests

coverage run -m pytest
coverage html

Update requirements

poetry lock
poetry export -f requirements.txt --output requirements.txt --without-hashes
oetry export -f requirements.txt --output requirements-dev.txt --without-hashes --with dev

Credit

FastAPI project generated using https://github.com/rafsaf/minimal-fastapi-postgres-template