QRKot

О проекте

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

В сервисе реализована возможность регистрации пользователей, добавления благотворительных проектов и пожертвований, которые распределяются по открытым проектам.

Настроено автоматическое создание первого суперпользователя при запуске проекта.

Добавлена возможность формирования отчёта в гугл-таблице с помощью сервисов Google Cloud Platform:

• Google Sheets API - управление электронными таблицами
• Google Drive API - упрвление файлами на гугл-диске

Автор проекта:

Валерий Шанкоренко
Github: Valera Shankorenko
Telegram:@valeron007
E-mail:valerashankorenko@yandex.by

Стек технологий

• Python
• FastAPI
• SQLAlchemy
• Alembic
• Pydantic
• Asyncio
• Google Cloud Platform
• Google Sheets API
• Google Drive API

Как запустить проект:

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

git clone git@github.com:valerashankorenko/QRkot_spreadsheets.git

cd QRkot_spreadsheets

2. Cоздать и активировать виртуальное окружение:

• для Linux/MacOS

python3 -m venv venv
source venv/bin/activate

• для Windows

python -m venv venv
source venv/Scripts/activate

3. Обновить пакетный менеджер pip

python3 -m pip install --upgrade pip

4. Установить зависимости из файла requirements.txt:

pip install -r requirements.txt

5. Создайте в корневой директории файл .env со следующим наполнением:

APP_TITLE=Приложение QRKot.
APP_DESC=Благотворительный фонд для сбора пожертвований.
DATABASE_URL=sqlite+aiosqlite:///./<название базы данных>.db
SECRET=<секретное слово>
FIRST_SUPERUSER_EMAIL=<email суперюзера>
FIRST_SUPERUSER_PASSWORD=<пароль суперюзера>
#Вводим данные сервисного гугл аккаунта
TYPE=service_account
PROJECT_ID=
PRIVATE_KEY_ID=
PRIVATE_KEY=
CLIENT_EMAIL=
CLIENT_ID=
AUTH_URI=
TOKEN_URI=
AUTH_PROVIDER_X509_CERT_URL=
CLIENT_X509_CERT_URL=
UNIVERSE_DOMAIN=
EMAIL=email гугл аккаунта

6. Автоматическое создание файла миграции для базы данных SQLite:

alembic revision --autogenerate -m "Название миграции" 

7. Применение всех неприменённых миграций:

alembic upgrade head

8. Запуск проекта:

uvicorn app.main:app --reload

Проект будет запущен и доступен по следующим адресам:

• http://127.0.0.1:8000
• http://127.0.0.1:8000/docs - автоматически сгенерированная документация Swagger
• http://127.0.0.1:8000/redoc - автоматически сгенерированная документация ReDoc
• http://127.0.0.1:8000/google - отчет в гугл-таблице

После запуска доступны следующие эндпоинты:

• Регистрация и аутентификация:
  • /auth/register - регистрация пользователя
  • /auth/jwt/login - аутентификация пользователя (получение jwt-токена)
  • /auth/jwt/logout - выход (сброс jwt-токена)
• Пользователи:
  • /users/me - получение и изменение данных аутентифицированного пользователя
  • /users/{id} - получение и изменение данных пользователя по id
• Благотворительные проекты:
  • /charity_project/ - получение списка проектов и создание нового
  • /charity_project/{project_id} - изменение и удаление существующего проекта
• Пожертвования:
  • /donation/ - получение списка всех пожертвований и создание пожертвования
  • /donation/my - получение списка всех пожертвований аутентифицированного пользователя
• GoogleAPI:
  • /google/ - создание отчёта в гугл-таблице