plusiv / fastapi-tortoise-api-base

API Base for Fastapi + Tortoise ORM projects

# myProfile.yaml
---
name: Jorge Massih
role: Cloud Engineer | Site Reliability Engineer | Backend Engineer
experience: "+5 years"
skills:
  - 💻 Computer Science
  - ☁️ Cloud Computing
  - 🔂 DevOps Culture
  - ✅ Problem Solving
  - 📄 Infrastructure as Code

about: |
    As an experienced SRE and Backend Engineer, I specialize in ensuring system reliability, scalability, 
    and performance. I excel in automating deployment pipelines, fosteringcollaboration between teams, 
    and swiftly responding to incidents. Proficient in Python and frameworks like Flask and FastAPI, 
    I develop RESTful APIs and microservices, optimizing database performance and data security. 
    With a proven track record of delivering complex projects, I'm dedicated to innovation and
    maintaining seamless user experiences.

contact:
  email: [email protected]
  github: https://github.com/plusiv
  linkedin: https://linkedin.com/in/jorgmassih

I feel confident with the following programming languages

I have years of experience working with those Cloud Service Providers

I've built houndreds of CI/CD pipelines with

I really love to use container technologies, specially

Here are some stats about me 😃

fastapi-tortoise-api-base's Issues

⚡️ Use AIOHTTP instead of request module

Since FastAPI and Tortoise ORM are async based modules, an async http client library would be more convenient for the job. Based on this lecture as reference, the better option for this case is AIOHTTP.

🐛 Update last_login field after successful login

👷 add ci

✨ Add Twillio integration for SMS sending

Use the Twillio API to send messages to targets.

✨ Add external Access Control manager - Casbin

Using an ABAC helps to easily manage access to resources in the API, this without the needs of delegate this complex task to a Database scheme. This approach simplifies the access control for resources. More information about this model can be found here.

This feature is inspired in this post.

🗃️ Add tables names to models

By adding the table name will avoid that database structure breaks at the moment of changing any class name.

✨ Add SendGrid integration for Email sending

This feature adds the ability of easily sending e-mail using the SendGrid API.

🚨 Add linter integration

Add Flake8 linter

✅ Add test to FastAPI endpoints

FastAPI test documentation can be found here.

🗃️ Integrate aerich for database migrations

Aerich is the default migration tool for Tortoise ORM.

✨ Add logging and trace module

This article shows how to add logging and trace module for FastAPI.

✨ Add user information endpoint

The endpoint /api/v1/user/me must return the following information about the user:

• First and Last names
• Birthday
• Email
• Sex
• Role Information
  • Id
  • Slug
  • Name
  • Description

🚑️ Fix user sex model type

Change User model field of sex from bool to str.

🔐 Add settings.py file for laoding secrets.

Adding the settings.py file and using the Pydantic features to handle .env files is more easy to manage and extend in Python. This documentation from FastAPI shows all necessary steps.