ohmyapi/README.md

# OhMyAPI

OhMyAPI is a web-application scaffolding framework and management layer built around `FastAPI`.
It is a thin layer that tightly integrates TortoiseORM and Aerich migrations.

> *Think: *"Django RestFramework"*, but less clunky and instead 100% async.*

It is ***blazingly fast***, extremely ***fun to use*** and comes with ***batteries included***!

**Features**

- 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)
- Customizable pydantic model serializer built-in
- Various optional built-in apps you can hook into your project (i.e. authentication and more)
- Highly configurable and customizable
- 100% async

**Goals**

- 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 adding any abstractions on top, unless they make things extremely convenient

## Installation

```
pipx install ohmyapi
```


## Docs

See `docs/` or:

```
poetry run mkdocs serve
```

Go to: [http://localhost:8000/](http://localhost:8000/)
🎉 Let's go! 2025-09-27 00:29:45 +02:00			`# OhMyAPI`

📝 Small improvements 2025-10-08 12:54:42 +02:00			OhMyAPI is a web-application scaffolding framework and management layer built around `FastAPI`.
			`It is a thin layer that tightly integrates TortoiseORM and Aerich migrations.`
🎉 Let's go! 2025-09-27 00:29:45 +02:00
📝 Small improvements 2025-10-08 12:54:42 +02:00			`> Think: "Django RestFramework", but less clunky and instead 100% async.`
🎉 Let's go! 2025-09-27 00:29:45 +02:00
📝 Reword 2025-09-28 19:36:48 +02:00			`It is *blazingly fast, extremely fun to use* and comes with *batteries included*!`
📝 Reflect latest changes in getting started docs 2025-09-27 13:28:37 +02:00
			`Features`
🎉 Let's go! 2025-09-27 00:29:45 +02:00
📝 Reword 2025-09-28 19:36:48 +02:00			`- Django-like project structure and application directories`
📝 Add mkdocs 2025-10-02 00:49:53 +02:00			`- Django-like per-app migrations (makemigrations & migrate) via Aerich`
			`- Django-like CLI tooling (startproject, startapp, shell, serve, etc)`
			`- Customizable pydantic model serializer built-in`
📝 Small improvements 2025-10-08 12:54:42 +02:00			`- Various optional built-in apps you can hook into your project (i.e. authentication and more)`
📝 Improve getting started docs 2025-09-27 12:46:38 +02:00			`- Highly configurable and customizable`
🎉 Let's go! 2025-09-27 00:29:45 +02:00			`- 100% async`

✏️ Better wording 2025-09-27 17:34:47 +02:00			`Goals`
📝 Use field.data.UUIDField as id in examples 2025-09-27 15:05:38 +02:00
📝 Add mkdocs 2025-10-02 00:49:53 +02:00			`- combine FastAPI, TortoiseORM, Aerich migrations and Pydantic into a high-productivity web-application framework`
📝 Reword 2025-09-28 19:36:48 +02:00			`- tie everything neatly together into a concise and straight-forward API`
📝 Add mkdocs 2025-10-02 00:49:53 +02:00			`- AVOID adding any abstractions on top, unless they make things extremely convenient`
📝 Use field.data.UUIDField as id in examples 2025-09-27 15:05:38 +02:00
📝 Add mkdocs 2025-10-02 00:49:53 +02:00			`## Installation`
🎉 Let's go! 2025-09-27 00:29:45 +02:00
			```
📝 Reflect latest changes 2025-09-29 17:17:54 +02:00			`pipx install ohmyapi`
📝 Add more info on migrations 2025-09-27 05:00:58 +02:00			```

🎉 Let's go! 2025-09-27 00:29:45 +02:00
📝 Add mkdocs 2025-10-02 00:49:53 +02:00			`## Docs`
📝 Reflect latest changes in getting started docs 2025-09-27 13:28:37 +02:00
📝 Add builtin section; add ohmyapi_auth docs 2025-10-02 02:04:19 +02:00			See `docs/` or:
📝 More info on shell command 2025-09-27 15:40:53 +02:00
📝 Add builtin section; add ohmyapi_auth docs 2025-10-02 02:04:19 +02:00			```
			`poetry run mkdocs serve`
			```

			`Go to: [http://localhost:8000/](http://localhost:8000/)`