diff --git a/README.md b/README.md index 2e388cf..5f41c58 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,31 @@

+

+ + Python + + + FastAPI + + + Pydantic + + + PostgreSQL + + + Redis + + + Docker + +

## 0. About **FastAPI boilerplate** creates an extendable async API using FastAPI, Pydantic V2, SQLAlchemy 2.0 and PostgreSQL: - [`FastAPI`](https://fastapi.tiangolo.com): modern Python web framework for building APIs -- [`Pydantic V2`](https://docs.pydantic.dev/2.4/): the most widely used data validation library for Python, rewritten in Rust [`(5x to 50x speed improvement)`](https://docs.pydantic.dev/latest/blog/pydantic-v2-alpha/) +- [`Pydantic V2`](https://docs.pydantic.dev/2.4/): the most widely used data validation library for Python, rewritten in Rust [`(5x-50x faster)`](https://docs.pydantic.dev/latest/blog/pydantic-v2-alpha/) - [`SQLAlchemy 2.0`](https://docs.sqlalchemy.org/en/20/changelog/whatsnew_20.html): Python SQL toolkit and Object Relational Mapper - [`PostgreSQL`](https://www.postgresql.org): The World's Most Advanced Open Source Relational Database - [`Redis`](https://redis.io): Open source, in-memory data store used by millions as a database, cache, streaming engine, and message broker @@ -32,15 +52,27 @@ - Easy running with docker compose ### 1.1 To Do -- [ ] Remove python-decouple in favor of starlette.config -- [ ] FastAPI docs behind authentication and hidden based on the environment -- [ ] Add mongoDB support -- [ ] Docs for other databases (MysQL, SQLite) +#### API - [ ] Add a photo upload endpoint for users - [ ] Add possibility of comments in posts - [ ] Add webhook to notify when a new comment is added in post -- [ ] Add Ruff linting + +#### Docs +- [ ] Docs for other databases (MysQL, SQLite) + +#### Features +- [ ] Add a Rate Limiter decorator +- [ ] Add mongoDB support + +#### Security +- [ ] FastAPI docs behind authentication and hidden based on the environment +#### Structure +- [ ] Remove python-decouple in favor of starlette.config + +#### Tests +- [ ] Add Ruff linter + ## 2. Contents 0. [About](#0-about) 1. [Features](#1-features)