|
9 | 9 | </a> |
10 | 10 | </p> |
11 | 11 |
|
| 12 | +<p align="center"> |
| 13 | + <a href=""> |
| 14 | + <img src="https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white" alt="Python"> |
| 15 | + </a> |
| 16 | + <a href="https://fastapi.tiangolo.com"> |
| 17 | + <img src="https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi" alt="FastAPI"> |
| 18 | + </a> |
| 19 | + <a href="https://docs.pydantic.dev/2.4/"> |
| 20 | + <img src="https://img.shields.io/badge/Pydantic-E92063?logo=pydantic&logoColor=fff&style=for-the-badge" alt="Pydantic"> |
| 21 | + </a> |
| 22 | + <a href="https://www.postgresql.org"> |
| 23 | + <img src="https://img.shields.io/badge/PostgreSQL-316192?style=for-the-badge&logo=postgresql&logoColor=white" alt="PostgreSQL"> |
| 24 | + </a> |
| 25 | + <a href="https://redis.io"> |
| 26 | + <img src="https://img.shields.io/badge/Redis-DC382D?logo=redis&logoColor=fff&style=for-the-badge" alt="Redis"> |
| 27 | + </a> |
| 28 | + <a href="https://docs.docker.com/compose/"> |
| 29 | + <img src="https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=fff&style=for-the-badge" alt="Docker"> |
| 30 | + </a> |
| 31 | +</p> |
12 | 32 |
|
13 | 33 | ## 0. About |
14 | 34 | **FastAPI boilerplate** creates an extendable async API using FastAPI, Pydantic V2, SQLAlchemy 2.0 and PostgreSQL: |
15 | 35 | - [`FastAPI`](https://fastapi.tiangolo.com): modern Python web framework for building APIs |
16 | | -- [`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/) |
| 36 | +- [`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/) |
17 | 37 | - [`SQLAlchemy 2.0`](https://docs.sqlalchemy.org/en/20/changelog/whatsnew_20.html): Python SQL toolkit and Object Relational Mapper |
18 | 38 | - [`PostgreSQL`](https://www.postgresql.org): The World's Most Advanced Open Source Relational Database |
19 | 39 | - [`Redis`](https://redis.io): Open source, in-memory data store used by millions as a database, cache, streaming engine, and message broker |
|
32 | 52 | - Easy running with docker compose |
33 | 53 |
|
34 | 54 | ### 1.1 To Do |
35 | | -- [ ] Remove python-decouple in favor of starlette.config |
36 | | -- [ ] FastAPI docs behind authentication and hidden based on the environment |
37 | | -- [ ] Add mongoDB support |
38 | | -- [ ] Docs for other databases (MysQL, SQLite) |
| 55 | +#### API |
39 | 56 | - [ ] Add a photo upload endpoint for users |
40 | 57 | - [ ] Add possibility of comments in posts |
41 | 58 | - [ ] Add webhook to notify when a new comment is added in post |
42 | | -- [ ] Add Ruff linting |
| 59 | + |
| 60 | +#### Docs |
| 61 | +- [ ] Docs for other databases (MysQL, SQLite) |
| 62 | + |
| 63 | +#### Features |
| 64 | +- [ ] Add a Rate Limiter decorator |
| 65 | +- [ ] Add mongoDB support |
| 66 | + |
| 67 | +#### Security |
| 68 | +- [ ] FastAPI docs behind authentication and hidden based on the environment |
43 | 69 |
|
| 70 | +#### Structure |
| 71 | +- [ ] Remove python-decouple in favor of starlette.config |
| 72 | + |
| 73 | +#### Tests |
| 74 | +- [ ] Add Ruff linter |
| 75 | + |
44 | 76 | ## 2. Contents |
45 | 77 | 0. [About](#0-about) |
46 | 78 | 1. [Features](#1-features) |
|
0 commit comments