elityaev / qrkot_spreadsheets

QRkot - это API сервис для сбора пожертвований в благотворительные проекты. Реализована возможность сортировки закрытых проектов по скорости сбора средств с последующем формированием отчета в Google-таблице

QRkot Spreadsheets

Описание

---

QRkot - это API сервис для сбора пожертвований в благотворительные проекты. В проекте реализованы функции создания благотворительны проектов, внесения пожертвований, автоматическое их распределение по открытым проектам в порядке очереди (First In, First Out). Настроена системы аутентификации и авторизации пользователей. При запуске проекта автоматически создается суперюзер.

Реализована возможность сортировки закрытых проектов по скорости сбора средств с последующем формированием отчета в Google-таблице

Технологии и библиотеки

---

• Python
• FastAPI
• SQLAlchemy
• Pydantic
• Alembic
• Asyncio
• GoogleAPI

Установка и запуск

---

1. Клонировать репозиторий и перейти в него в командной строке:

git clone [email protected]:elityaev/cat_charity_fund.git

2. Создать и активировать виртуальное окружение, обновить библиотеку pip, установить зависимости:

python -m venv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt

3. В корневой директории создать и заполнить env-файл по следующему шаблону:

APP_TITLE=Благотворительный фонд поддержки котиков QRKot
DATABASE_URL=sqlite+aiosqlite:///./<название базы данных>.db
SECRET=<секретное слово>
FIRST_SUPERUSER_EMAIL=<email суперюзера>
FIRST_SUPERUSER_PASSWORD=<пароль суперюзера>
# Данные для сервисного аккаунта GoogleCloudPlatform
TYPE=service_account
PROJECT_ID=project-id
PRIVATE_KEY_ID=private-key-id
CLIENT_EMAIL=client-email
CLIENT_ID=client-id
AUTH_URI=auth-uri
TOKE_URI=token-uri
AUTH_PROVIDER_X509_CERT_URL=provider-cert-url
CLIENT_X509_CERT_URL=client-cert-url

4. Применить миграции для создания БД

alembic upgrade head

5. Запустить локальный сервер

uvicorn app.main:app --reload

Документация к API будет доступна по следующим адресам:

http://127.0.0.1:8000/docs - Swagger

http://127.0.0.1:8000/docs - ReDoc

---

Автор

Литяев Евгений