From ff8384d2c5bf8c59078e13cdb2e0bcef4f78f491 Mon Sep 17 00:00:00 2001 From: Brian Wiborg Date: Sun, 28 Sep 2025 19:36:48 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Reword?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6cee2f9..6e4946f 100644 --- a/README.md +++ b/README.md @@ -2,29 +2,26 @@ > Think: Django RestFramework, but less clunky and 100% async. -OhMyAPI is a Django-flavored web-application scaffolding framework and management layer. -Built around FastAPI and TortoiseORM, it is 100% async. +OhMyAPI is a Django-flavored web-application scaffolding framework and management layer, +built around FastAPI and TortoiseORM and is thus 100% async. -It is ***blazingly fast***, ***fun to use*** and comes with ***batteries included***! +It is ***blazingly fast***, extremely ***fun to use*** and comes with ***batteries included***! **Features** -- Django-like project-layout and -structure -- Django-like project-level settings.py -- Django-like models via TortoiseORM -- Django-like `Model.Meta` class for model configuration -- Easily convert your query results to `pydantic` models via `Model.Schema` -- Django-like migrations (`makemigrations` & `migrate`) via Aerich +- Django-like project structure and application directories +- Django-like per-app migrations (`makemigrations` & `migrate`) via Aerich - Django-like CLI tooling (`startproject`, `startapp`, `shell`, `serve`, etc) -- Various optional builtin apps you can hook into your project +- Customizable pydantic model serializer built-in +- Various optional built-in apps you can hook into your project - Highly configurable and customizable - 100% async **Goals** -- combine FastAPI, TortoiseORM and Aerich migrations into a high-productivity web-application framework -- tie everything neatly together into a concise API -- while ***AVOIDING*** any additional abstractions ontop of Tortoise's model-system or FastAPI's routing system +- combine `FastAPI`, `TortoiseORM`, `Aerich` migrations and `Pydantic` into a high-productivity web-application framework +- tie everything neatly together into a concise and straight-forward API +- ***AVOID*** any adding abstractions unless making things extremely convenient ---