ohmyapi 0.1.21__tar.gz → 0.1.22__tar.gz

{ohmyapi-0.1.21 → ohmyapi-0.1.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ohmyapi
-Version: 0.1.21
+Version: 0.1.22
 Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
 License-Expression: MIT
 Keywords: fastapi,tortoise,orm,async,web-framework
@@ -157,7 +157,7 @@ class Team(Model):
 Next, create your endpoints in `tournament/routes.py`:
 
 ```python
-from ohmyapi.router import APIRouter, HTTPException
+from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
 from ohmyapi.db.exceptions import DoesNotExist
 
 from .models import Tournament
@@ -167,20 +167,25 @@ from .models import Tournament
 # Tags improve the UX of the OpenAPI docs at /docs.
 router = APIRouter(prefix="/tournament", tags=['Tournament'])
 
-
 @router.get("/")
 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):
+    queryset = Tournament.create(**payload.model_dump())
+    return await Tournament.Schema.model.from_queryset(queryset)
+
+
 @router.get("/:id")
 async def get(id: str):
     try:
-        tournament = await Tournament.get(pk=id)
+        queryset = Tournament.get(id=id)
         return await Tournament.Schema.model.from_queryset_single(tournament)
     except DoesNotExist:
-        raise HTTPException(status_code=404, detail="item not found")
+        raise HTTPException(status_code=404, detail="not found")
 
 ...
 ```
@@ -350,28 +355,66 @@ Find your loaded project singleton via identifier: `p`
 
 ```python
 In [1]: p
-Out[1]: <ohmyapi.core.runtime.Project at 0xdeadbeefc0febabe>
+Out[1]: <ohmyapi.core.runtime.Project at 0x7f00c43dbcb0>
 
 In [2]: p.apps
 Out[2]:
-{'ohmyapi_auth': App: ohmyapi_auth
- Models:
-  - Group
-  - User
- Routes:
-  - APIRoute(path='/auth/login', name='login', methods=['POST'])
-  - APIRoute(path='/auth/refresh', name='refresh_token', methods=['POST'])
-  - APIRoute(path='/auth/introspect', name='introspect', methods=['GET'])
-  - APIRoute(path='/auth/me', name='me', methods=['GET']),
- 'tournament': App: tournament
- Models:
-  - Tournament
-  - Event
-  - Team
- Routes:
-  - APIRoute(path='/tournament/', name='list', methods=['GET'])}
-
-In [3]: from tournament.models import Tournament
+{'ohmyapi_auth': {
+   "models": [
+     "Group",
+     "User"
+   ],
+   "routes": [
+     {
+       "path": "/auth/login",
+       "name": "login",
+       "methods": [
+         "POST"
+       ],
+       "endpoint": "login",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/refresh",
+       "name": "refresh_token",
+       "methods": [
+         "POST"
+       ],
+       "endpoint": "refresh_token",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/introspect",
+       "name": "introspect",
+       "methods": [
+         "GET"
+       ],
+       "endpoint": "introspect",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/me",
+       "name": "me",
+       "methods": [
+         "GET"
+       ],
+       "endpoint": "me",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     }
+   ]
+ }}
 ```
 
 

{ohmyapi-0.1.21 → ohmyapi-0.1.22}/README.md

@@ -125,7 +125,7 @@ class Team(Model):
 Next, create your endpoints in `tournament/routes.py`:
 
 ```python
-from ohmyapi.router import APIRouter, HTTPException
+from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
 from ohmyapi.db.exceptions import DoesNotExist
 
 from .models import Tournament
@@ -135,20 +135,25 @@ from .models import Tournament
 # Tags improve the UX of the OpenAPI docs at /docs.
 router = APIRouter(prefix="/tournament", tags=['Tournament'])
 
-
 @router.get("/")
 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):
+    queryset = Tournament.create(**payload.model_dump())
+    return await Tournament.Schema.model.from_queryset(queryset)
+
+
 @router.get("/:id")
 async def get(id: str):
     try:
-        tournament = await Tournament.get(pk=id)
+        queryset = Tournament.get(id=id)
         return await Tournament.Schema.model.from_queryset_single(tournament)
     except DoesNotExist:
-        raise HTTPException(status_code=404, detail="item not found")
+        raise HTTPException(status_code=404, detail="not found")
 
 ...
 ```
@@ -318,27 +323,65 @@ Find your loaded project singleton via identifier: `p`
 
 ```python
 In [1]: p
-Out[1]: <ohmyapi.core.runtime.Project at 0xdeadbeefc0febabe>
+Out[1]: <ohmyapi.core.runtime.Project at 0x7f00c43dbcb0>
 
 In [2]: p.apps
 Out[2]:
-{'ohmyapi_auth': App: ohmyapi_auth
- Models:
-  - Group
-  - User
- Routes:
-  - APIRoute(path='/auth/login', name='login', methods=['POST'])
-  - APIRoute(path='/auth/refresh', name='refresh_token', methods=['POST'])
-  - APIRoute(path='/auth/introspect', name='introspect', methods=['GET'])
-  - APIRoute(path='/auth/me', name='me', methods=['GET']),
- 'tournament': App: tournament
- Models:
-  - Tournament
-  - Event
-  - Team
- Routes:
-  - APIRoute(path='/tournament/', name='list', methods=['GET'])}
-
-In [3]: from tournament.models import Tournament
+{'ohmyapi_auth': {
+   "models": [
+     "Group",
+     "User"
+   ],
+   "routes": [
+     {
+       "path": "/auth/login",
+       "name": "login",
+       "methods": [
+         "POST"
+       ],
+       "endpoint": "login",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/refresh",
+       "name": "refresh_token",
+       "methods": [
+         "POST"
+       ],
+       "endpoint": "refresh_token",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/introspect",
+       "name": "introspect",
+       "methods": [
+         "GET"
+       ],
+       "endpoint": "introspect",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     },
+     {
+       "path": "/auth/me",
+       "name": "me",
+       "methods": [
+         "GET"
+       ],
+       "endpoint": "me",
+       "response_model": null,
+       "tags": [
+         "auth"
+       ]
+     }
+   ]
+ }}
 ```
 

{ohmyapi-0.1.21 → ohmyapi-0.1.22}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ohmyapi"
-version = "0.1.21"
+version = "0.1.22"
 description = "A Django-like but async web-framework based on FastAPI and TortoiseORM."
 license = "MIT"
 keywords = ["fastapi", "tortoise", "orm", "async", "web-framework"]

ohmyapi-0.1.22/src/ohmyapi/core/templates/app/routes.py.j2

@@ -0,0 +1,41 @@
+from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
+
+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.
+# Tags improve the UX of the OpenAPI docs at /docs.
+router = APIRouter(prefix="/{{ app_name }}", tags=['{{ app_name }}'])
+
+
+
+@router.get("/")
+async def list():
+    """List all ..."""
+    return []
+
+
+@router.post("/")
+async def post():
+    """Create ..."""
+    return HTTPException(status_code=HTTPStatus.CREATED)
+
+
+@router.get("/{id}")
+async def get(id: str):
+    """Get single ..."""
+    return {}
+
+
+@router.put("/{id}")
+async def put(id: str):
+    """Update ..."""
+    return HTTPException(status_code=HTTPStatus.ACCEPTED)
+
+
+@router.delete("/{id}")
+async def delete(id: str):
+    return HTTPException(status_code=HTTPStatus.ACCEPTED)
+

{ohmyapi-0.1.21 → ohmyapi-0.1.22}/src/ohmyapi/router.py

@@ -1 +1,3 @@
 from fastapi import APIRouter, Depends, HTTPException
+from http import HTTPStatus
+

ohmyapi-0.1.21/src/ohmyapi/core/templates/app/routes.py.j2

@@ -1,17 +0,0 @@
-from ohmyapi.router import APIRouter
-
-from .models import ...
-
-# 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="/{{ app_name }}", tags=['{{ app_name }}'])
-
-
-@router.get("/")
-def hello_world():
-    return {
-        "project": "{{ project_name }}",
-        "app": "{{ app_name }}",
-    }
-