baccenfutter/ohmyapi
1
2
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📝 Reword

Browse source
This commit is contained in:
Brian Wiborg 2025-09-28 19:36:48 +02:00
parent 250bf142ed
commit ff8384d2c5
No known key found for this signature in database
1 changed files with 10 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -2,29 +2,26 @@
> Think: Django RestFramework, but less clunky and 100% async. > Think: Django RestFramework, but less clunky and 100% async.
OhMyAPI is a Django-flavored web-application scaffolding framework and management layer. OhMyAPI is a Django-flavored web-application scaffolding framework and management layer,
Built around FastAPI and TortoiseORM, it is 100% async. 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** **Features**
- Django-like project-layout and -structure - Django-like project structure and application directories
- Django-like project-level settings.py - Django-like per-app migrations (`makemigrations` & `migrate`) via Aerich
- 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 CLI tooling (`startproject`, `startapp`, `shell`, `serve`, etc) - 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 - Highly configurable and customizable
- 100% async - 100% async
**Goals** **Goals**
- combine FastAPI, TortoiseORM and Aerich migrations into a high-productivity web-application framework - combine `FastAPI`, `TortoiseORM`, `Aerich` migrations and `Pydantic` into a high-productivity web-application framework
- tie everything neatly together into a concise API - tie everything neatly together into a concise and straight-forward API
- while ***AVOIDING*** any additional abstractions ontop of Tortoise's model-system or FastAPI's routing system - ***AVOID*** any adding abstractions unless making things extremely convenient
--- ---