ohmyapi 0.1.24__tar.gz → 0.1.26__tar.gz

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/PKG-INFO

@@ -1,13 +1,16 @@
 Metadata-Version: 2.4
 Name: ohmyapi
-Version: 0.1.24
-Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
+Version: 0.1.26
+Summary: Django-flavored scaffolding and management layer around FastAPI, Pydantic, TortoiseORM and Aerich migrations
 License-Expression: MIT
-Keywords: fastapi,tortoise,orm,async,web-framework
+Keywords: fastapi,tortoise,orm,pydantic,async,web-framework
 Author: Brian Wiborg
 Author-email: me@brianwib.org
-Requires-Python: >=3.13
+Requires-Python: >=3.10
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Provides-Extra: auth
@@ -62,7 +65,7 @@ It is ***blazingly fast***, extremely ***fun to use*** and comes with ***batteri
 **Creating a Project**
 
 ```
-pip install ohmyapi
+pipx install ohmyapi
 ohmyapi startproject myproject
 cd myproject
 ```
@@ -157,33 +160,50 @@ Next, create your endpoints in `tournament/routes.py`:
 from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
 from ohmyapi.db.exceptions import DoesNotExist
 
+from typing import List
+
 from .models import Tournament
 
-# Expose your app's routes via `router = fastapi.APIRouter`.
-# Use prefixes wisely to avoid cross-app namespace-collisions.
+# OhMyAPI will automatically pick up all instances of `fastapi.APIRouter` and
+# add their routes to the main project router.
+#
+# Note:
+# Use prefixes wisely to avoid cross-app namespace-collisions!
 # Tags improve the UX of the OpenAPI docs at /docs.
-router = APIRouter(prefix="/tournament", tags=['Tournament'])
+#
+tournament_router = APIRouter(prefix="/tournament", tags=['Tournament'])
 
-@router.get("/")
+
+@tournament_router.get("/", response_model=List[Tournament.Schema()])
 async def list():
     queryset = Tournament.all()
     return await Tournament.Schema.model.from_queryset(queryset)
 
 
-@router.post("/", status_code=HTTPStatus.CREATED)
-async def post(tournament: Tournament.Schema.readonly):
+@tournament_router.post("/", status_code=HTTPStatus.CREATED)
+async def post(tournament: Tournament.Schema(readonly=True)):
     queryset = Tournament.create(**payload.model_dump())
-    return await Tournament.Schema.model.from_queryset(queryset)
+    return await Tournament.Schema().from_queryset(queryset)
 
 
-@router.get("/:id")
+@tournament_router.get("/:id", response_model=Tournament.Schema())
 async def get(id: str):
     try:
         queryset = Tournament.get(id=id)
-        return await Tournament.Schema.model.from_queryset_single(tournament)
+        return await Tournament.Schema().from_queryset_single(tournament)
+    except DoesNotExist:
+        raise HTTPException(status_code=404, detail="not found")
+
+
+@tournament_router.delete("/:id")
+async def delete(id: str):
+    try:
+        tournament = await Tournament.get(id=id)
+        return await Tournament.Schema.model.from_queryset(tournament.delete())
     except DoesNotExist:
         raise HTTPException(status_code=404, detail="not found")
 
+
 ...
 ```
 
@@ -290,7 +310,7 @@ router = APIRouter(prefix="/tournament", tags=["Tournament"])
 @router.get("/")
 async def list(user: auth.User = Depends(permissions.require_authenticated)):
     queryset = Tournament.all()
-    return await Tournament.Schema.model.from_queryset(queryset)
+    return await Tournament.Schema().from_queryset(queryset)
 
 
 ...
@@ -332,7 +352,7 @@ router = APIRouter(prefix="/tournament", tags=["Tournament"])
 @router.get("/teams")
 async def teams(user: auth.User = Depends(permissions.require_authenticated)):
     queryset = Team.for_user(user)
-    return await Tournament.Schema.model.from_queryset(queryset)
+    return await Tournament.Schema().from_queryset(queryset)
 ```
 
 ## Shell

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/README.md

@@ -30,7 +30,7 @@ It is ***blazingly fast***, extremely ***fun to use*** and comes with ***batteri
 **Creating a Project**
 
 ```
-pip install ohmyapi
+pipx install ohmyapi
 ohmyapi startproject myproject
 cd myproject
 ```
@@ -125,33 +125,50 @@ Next, create your endpoints in `tournament/routes.py`:
 from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
 from ohmyapi.db.exceptions import DoesNotExist
 
+from typing import List
+
 from .models import Tournament
 
-# Expose your app's routes via `router = fastapi.APIRouter`.
-# Use prefixes wisely to avoid cross-app namespace-collisions.
+# OhMyAPI will automatically pick up all instances of `fastapi.APIRouter` and
+# add their routes to the main project router.
+#
+# Note:
+# Use prefixes wisely to avoid cross-app namespace-collisions!
 # Tags improve the UX of the OpenAPI docs at /docs.
-router = APIRouter(prefix="/tournament", tags=['Tournament'])
+#
+tournament_router = APIRouter(prefix="/tournament", tags=['Tournament'])
 
-@router.get("/")
+
+@tournament_router.get("/", response_model=List[Tournament.Schema()])
 async def list():
     queryset = Tournament.all()
     return await Tournament.Schema.model.from_queryset(queryset)
 
 
-@router.post("/", status_code=HTTPStatus.CREATED)
-async def post(tournament: Tournament.Schema.readonly):
+@tournament_router.post("/", status_code=HTTPStatus.CREATED)
+async def post(tournament: Tournament.Schema(readonly=True)):
     queryset = Tournament.create(**payload.model_dump())
-    return await Tournament.Schema.model.from_queryset(queryset)
+    return await Tournament.Schema().from_queryset(queryset)
 
 
-@router.get("/:id")
+@tournament_router.get("/:id", response_model=Tournament.Schema())
 async def get(id: str):
     try:
         queryset = Tournament.get(id=id)
-        return await Tournament.Schema.model.from_queryset_single(tournament)
+        return await Tournament.Schema().from_queryset_single(tournament)
+    except DoesNotExist:
+        raise HTTPException(status_code=404, detail="not found")
+
+
+@tournament_router.delete("/:id")
+async def delete(id: str):
+    try:
+        tournament = await Tournament.get(id=id)
+        return await Tournament.Schema.model.from_queryset(tournament.delete())
     except DoesNotExist:
         raise HTTPException(status_code=404, detail="not found")
 
+
 ...
 ```
 
@@ -258,7 +275,7 @@ router = APIRouter(prefix="/tournament", tags=["Tournament"])
 @router.get("/")
 async def list(user: auth.User = Depends(permissions.require_authenticated)):
     queryset = Tournament.all()
-    return await Tournament.Schema.model.from_queryset(queryset)
+    return await Tournament.Schema().from_queryset(queryset)
 
 
 ...
@@ -300,7 +317,7 @@ router = APIRouter(prefix="/tournament", tags=["Tournament"])
 @router.get("/teams")
 async def teams(user: auth.User = Depends(permissions.require_authenticated)):
     queryset = Team.for_user(user)
-    return await Tournament.Schema.model.from_queryset(queryset)
+    return await Tournament.Schema().from_queryset(queryset)
 ```
 
 ## Shell

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/pyproject.toml

@@ -1,14 +1,14 @@
 [project]
 name = "ohmyapi"
-version = "0.1.24"
-description = "A Django-like but async web-framework based on FastAPI and TortoiseORM."
+version = "0.1.26"
+description = "Django-flavored scaffolding and management layer around FastAPI, Pydantic, TortoiseORM and Aerich migrations"
 license = "MIT"
-keywords = ["fastapi", "tortoise", "orm", "async", "web-framework"]
+keywords = ["fastapi", "tortoise", "orm", "pydantic", "async", "web-framework"]
 authors = [
     {name = "Brian Wiborg", email = "me@brianwib.org"}
 ]
 readme = "README.md"
-requires-python = ">=3.13"
+requires-python = ">=3.10"
 
 dependencies = [
     "typer >=0.19.1,<0.20.0",

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/src/ohmyapi/builtin/auth/routes.py

@@ -207,7 +207,7 @@ async def introspect(token: Dict = Depends(get_token)):
     return token
 
 
-@router.get("/me", response_model=User.Schema.model)
+@router.get("/me", response_model=User.Schema())
 async def me(user: User = Depends(get_current_user)):
     """Return the currently authenticated user."""
-    return await User.Schema.model.from_tortoise_orm(user)
+    return await User.Schema().from_tortoise_orm(user)

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/src/ohmyapi/builtin/demo/routes.py

@@ -8,29 +8,29 @@ from typing import List
 # Expose your app's routes via `router = fastapi.APIRouter`.
 # Use prefixes wisely to avoid cross-app namespace-collisions.
 # Tags improve the UX of the OpenAPI docs at /docs.
-router = APIRouter(prefix="/tournemant")
+router = APIRouter(prefix="/tournament")
 
 
 @router.get(
-    "/", tags=["tournament"], response_model=List[models.Tournament.Schema.model]
+    "/", tags=["tournament"], response_model=List[models.Tournament.Schema()]
 )
 async def list():
     """List all tournaments."""
-    return await models.Tournament.Schema.model.from_queryset(models.Tournament.all())
+    return await models.Tournament.Schema().from_queryset(models.Tournament.all())
 
 
 @router.post("/", tags=["tournament"], status_code=HTTPStatus.CREATED)
-async def post(tournament: models.Tournament.Schema.readonly):
+async def post(tournament: models.Tournament.Schema(readonly=True)):
     """Create tournament."""
-    return await models.Tournament.Schema.model.from_queryset(
+    return await models.Tournament.Schema().from_queryset(
         models.Tournament.create(**tournament.model_dump())
     )
 
 
-@router.get("/{id}", tags=["tournament"], response_model=models.Tournament.Schema.model)
+@router.get("/{id}", tags=["tournament"], response_model=models.Tournament.Schema())
 async def get(id: str):
     """Get tournament by id."""
-    return await models.Tournament.Schema.model.from_queryset(
+    return await models.Tournament.Schema().from_queryset(
         models.Tournament.get(id=id)
     )
 
@@ -43,12 +43,12 @@ async def get(id: str):
 )
 async def put(tournament: models.Tournament.Schema.model):
     """Update tournament."""
-    return await models.Tournament.Schema.model.from_queryset(
+    return await models.Tournament.Schema().from_queryset(
         models.Tournament.update(**tournament.model_dump())
     )
 
 
-@router.delete("/{id}", tags=["tournament"])
+@router.delete("/{id}", status_code=HTTPStatus.ACCEPTED, tags=["tournament"])
 async def delete(id: str):
     try:
         tournament = await models.Tournament.get(id=id)

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/src/ohmyapi/core/runtime.py

@@ -211,7 +211,7 @@ class App:
         self.model_modules: List[str] = []
 
         # The APIRouter
-        self.router: Optional[APIRouter] = None
+        self.router: APIRouter = APIRouter()
 
         # Import the app, so its __init__.py runs.
         importlib.import_module(self.name)
@@ -226,9 +226,12 @@ class App:
         # Locate the APIRouter
         try:
             routes_mod = importlib.import_module(f"{self.name}.routes")
-            router = getattr(routes_mod, "router", None)
-            if isinstance(router, APIRouter):
-                self.router = router
+            for attr_name in dir(routes_mod):
+                if attr_name.startswith("__"):
+                    continue
+                attr = getattr(routes_mod, attr_name)
+                if isinstance(attr, APIRouter):
+                    self.router.include_router(attr)
         except ModuleNotFoundError:
             pass
 

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/src/ohmyapi/core/templates/app/routes.py.j2

@@ -4,23 +4,26 @@ from . import models
 
 from typing import List
 
-# Expose your app's routes via `router = fastapi.APIRouter`.
-# Use prefixes wisely to avoid cross-app namespace-collisions.
+# OhMyAPI will automatically pick up all instances of `fastapi.APIRouter` and
+# add their routes to the main project router.
+#
+# Note:
+# Use prefixes wisely to avoid cross-app namespace-collisions!
 # Tags improve the UX of the OpenAPI docs at /docs.
+#
 router = APIRouter(prefix="/{{ app_name }}", tags=['{{ app_name }}'])
 
 
-
-@router.get("/")
+@router.get("/", response_model=List)
 async def list():
     """List all ..."""
     return []
 
 
-@router.post("/")
+@router.post("/", status_code=HTTPStatus.CREATED)
 async def post():
     """Create ..."""
-    return HTTPException(status_code=HTTPStatus.CREATED)
+    raise HTTPException(status_code=HTTPStatus.IM_A_TEAPOT)
 
 
 @router.get("/{id}")
@@ -35,7 +38,7 @@ async def put(id: str):
     return HTTPException(status_code=HTTPStatus.ACCEPTED)
 
 
-@router.delete("/{id}")
+@router.delete("/{id}", status_code=HTTPStatus.ACCEPTED)
 async def delete(id: str):
     return HTTPException(status_code=HTTPStatus.ACCEPTED)
 

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/src/ohmyapi/core/templates/project/settings.py.j2

@@ -2,6 +2,6 @@
 PROJECT_NAME = "MyProject"
 DATABASE_URL = "sqlite://db.sqlite3"
 INSTALLED_APPS = [
-  #'ohmyapi_auth',
+    #"ohmyapi_auth",
 ]
 

{ohmyapi-0.1.24 → ohmyapi-0.1.26}/src/ohmyapi/db/model/model.py

@@ -36,6 +36,11 @@ class ModelMeta(type(TortoiseModel)):
         schema_opts = getattr(new_cls, "Schema", None)
 
         class BoundSchema:
+            def __call__(self, readonly: bool = False):
+                if readonly:
+                    return self.readonly
+                return self.model
+
             @property
             def model(self):
                 """Return a Pydantic model class for serializing results."""