hackpi 0.1.1

HackPi - is a library for the FastAPI framework that adds additional functionality that simplifies development.

HackPi

HackPi - is a library for the FastAPI framework that adds additional functionality that simplifies development.

Introduction

Features:

• Генерация endpoints по моделям SQLAlchemy и Pydantic
• Самая простая генерация JWT-токенов
• Отправка писем с кодом активации/восстановления на почту
• Двухфакторная аутентификация используя TOTP
• Готовые методы регистрации, авторизации
• Система ролей с возможностью ограничения доступа

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

Installing

Чтобы установить библиотеку, выполните в терминале простую команду:

pip3 install hackpi

Чтобы проверить наличие библиотеки на компьютере, нужно ввести следующую команду:

pip3 list

И в выведенном вы увидите библиотеку hackpi с текущей версией (актуальная - 0.1.1).

Ура! Теперь вы можете пользоваться всеми возможностями HackPi.

Usage

Подключение к базе данных

Для подключения к базе данных используется класс Database. При содании объекта этого класса, нужно передать в конструктор расположение SQLite3 базы данных. Пока что HackPi может работать только с этой базой данных.

# db.py
from hackpi.Database import Database

db = Database('sqlite:///database.sqlite3')

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

Модели SQLAlchemy и Pydantic

В этом туториале вы увидите работу библиотеки на примере работы с пользователем. Нам всегда необходимо иметь две модели: модель SQLAlchemy и модель Pydantic.

# models.py
from hackpi.Database import Base
from sqlalchemy import Column, Integer, String
from db import db

class User(Base):
	__tablename__ = 'users'

	id: int = Column(Integer, primary_key=True)
	email: str = Column(String, unique=True)
	password: str = Column(String)

db.create_all()

Разберем файл models.py. Мы создали модель SQLAlchemy, наследовав ее от Base. Название таблицы - users. Таблица имеет следующие столбцы: id, email, password. Затем, мы вызвали метод для создания таблицы в базе данных.

# schemas.py
from pydantic import BaseModel

class User(BaseModel):
	email: str
	password: str

Мы создали простую схему Pydantic, которая содержит в себе только email и password.

Создание роутеров

Итак, чтобы сгенерировать эндпоинты, используя модели SQLAlchemy и Pydantic, необходимо создать main.py файл, и написать в нем следующее:

# main.py
from fastapi import FastAPI
from hackpi.Router import Router
from models import User as UserModel
from schemas import User as UserSchema
from db import db

app = FastAPI()

router = Router(db, UserModel, UserSchema)

app.include_router(router.get_router())

Введя команду uvicorn main:app --reload в терминал, запустится бекенд. Можно перейти в документацию, и увидеть результат генерации эндпоинтов.