ohmyapi 0.1.10__tar.gz → 0.1.12__tar.gz

{ohmyapi-0.1.10 → ohmyapi-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ohmyapi
-Version: 0.1.10
+Version: 0.1.12
 Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
 License-Expression: MIT
 Keywords: fastapi,tortoise,orm,async,web-framework
@@ -158,7 +158,10 @@ from ohmyapi.db.exceptions import DoesNotExist
 
 from .models import Tournament
 
-router = APIRouter(prefix="/tournament")
+# 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="/tournament", tags=['Tournament'])
 
 
 @router.get("/")
@@ -264,8 +267,6 @@ In your `routes.py`:
 
 ```python
 from ohmyapi.router import APIRouter, Depends
-
-from ohmyapi_auth.models import User
 from ohmyapi_auth import (
     models as auth,
     permissions,
@@ -273,7 +274,7 @@ from ohmyapi_auth import (
 
 from .models import Tournament
 
-router = APIRouter(prefix="/tournament")
+router = APIRouter(prefix="/tournament", tags=["Tournament"])
 
 
 @router.get("/")
@@ -291,10 +292,11 @@ Use Tortoise's `Manager` to implement model-level permissions.
 
 ```python
 from ohmyapi.db import Manager
+from ohmyapi_auth.models import User
 
 
 class TeamManager(Manager):
-    async def for_user(self, user: ohmyapi_auth.models.User):
+    async def for_user(self, user: User):
         return await self.filter(members=user).all()
 
 
@@ -305,6 +307,24 @@ class Team(Model):
         manager = TeamManager()
 ```
 
+Use the custom manager in your FastAPI route handler:
+
+```python
+from ohmyapi.router import APIRouter
+from ohmyapi_auth import (
+    models as auth,
+    permissions,
+)
+
+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.many.from_queryset(queryset)
+```
+
 ## Shell
 
 Similar to Django, you can attach to an interactive shell with your project already loaded inside.

{ohmyapi-0.1.10 → ohmyapi-0.1.12}/README.md

@@ -126,7 +126,10 @@ from ohmyapi.db.exceptions import DoesNotExist
 
 from .models import Tournament
 
-router = APIRouter(prefix="/tournament")
+# 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="/tournament", tags=['Tournament'])
 
 
 @router.get("/")
@@ -232,8 +235,6 @@ In your `routes.py`:
 
 ```python
 from ohmyapi.router import APIRouter, Depends
-
-from ohmyapi_auth.models import User
 from ohmyapi_auth import (
     models as auth,
     permissions,
@@ -241,7 +242,7 @@ from ohmyapi_auth import (
 
 from .models import Tournament
 
-router = APIRouter(prefix="/tournament")
+router = APIRouter(prefix="/tournament", tags=["Tournament"])
 
 
 @router.get("/")
@@ -259,10 +260,11 @@ Use Tortoise's `Manager` to implement model-level permissions.
 
 ```python
 from ohmyapi.db import Manager
+from ohmyapi_auth.models import User
 
 
 class TeamManager(Manager):
-    async def for_user(self, user: ohmyapi_auth.models.User):
+    async def for_user(self, user: User):
         return await self.filter(members=user).all()
 
 
@@ -273,6 +275,24 @@ class Team(Model):
         manager = TeamManager()
 ```
 
+Use the custom manager in your FastAPI route handler:
+
+```python
+from ohmyapi.router import APIRouter
+from ohmyapi_auth import (
+    models as auth,
+    permissions,
+)
+
+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.many.from_queryset(queryset)
+```
+
 ## Shell
 
 Similar to Django, you can attach to an interactive shell with your project already loaded inside.

{ohmyapi-0.1.10 → ohmyapi-0.1.12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ohmyapi"
-version = "0.1.10"
+version = "0.1.12"
 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.10 → ohmyapi-0.1.12}/src/ohmyapi/builtin/auth/permissions.py

@@ -4,4 +4,5 @@ from .routes import (
     require_authenticated,
     require_admin,
     require_staff,
+    require_group,
 )

{ohmyapi-0.1.10 → ohmyapi-0.1.12}/src/ohmyapi/builtin/auth/routes.py

@@ -95,7 +95,7 @@ async def require_admin(current_user: User = Depends(get_current_user)) -> User:
 
 async def require_staff(current_user: User = Depends(get_current_user)) -> User:
     """Ensure the current user is a staff member."""
-    if not current_user.is_staff:
+    if not current_user.is_admin and not current_user.is_staff:
         raise HTTPException(403, "Staff privileges required")
     return current_user
 
@@ -152,17 +152,13 @@ async def refresh_token(refresh_token: str):
     return {"access_token": new_access, "token_type": "bearer"}
 
 
+@router.get("/introspect")
+async def introspect(token: Dict = Depends(get_token)):
+    return token
+
+
 @router.get("/me")
 async def me(user: User = Depends(get_current_user)):
     """Return the currently authenticated user."""
-    return {
-        "email": user.email,
-        "username": user.username,
-        "is_admin": user.is_admin,
-        "is_staff": user.is_staff,
-    }
-
+    return user
 
-@router.get("/introspect")
-async def introspect(token: Dict = Depends(get_token)):
-    return token

{ohmyapi-0.1.10 → ohmyapi-0.1.12}/src/ohmyapi/cli.py

@@ -16,13 +16,13 @@ Find your loaded project singleton via identifier: `p`
 
 @app.command()
 def startproject(name: str):
-    """Create a new OhMyAPI project in the given directory"""
+    """Create a new OhMyAPI project in the given directory."""
     scaffolding.startproject(name)
 
 
 @app.command()
 def startapp(app_name: str, root: str = "."):
-    """Create a new app with the given name in your OhMyAPI project"""
+    """Create a new app with the given name in your OhMyAPI project."""
     scaffolding.startapp(app_name, root)
 
 
@@ -93,6 +93,10 @@ def migrate(app: str = "*", root: str = "."):
 
 @app.command()
 def createsuperuser(root: str = "."):
+    """Create a superuser in the DB.
+
+    This requires the presence of `ohmyapi_auth` in your INSTALLED_APPS to work.
+    """
     project_path = Path(root).resolve()
     project = runtime.Project(project_path)
     if not project.is_app_installed("ohmyapi_auth"):
@@ -103,9 +107,14 @@ def createsuperuser(root: str = "."):
     import ohmyapi_auth
     email = input("E-Mail: ")
     username = input("Username: ")
-    password = getpass("Password: ")
+    password1, password2 = "foo", "bar"
+    while password1 != password2:
+        password1 = getpass("Password: ")
+        password2 = getpass("Repeat Password: ")
+        if password1 != password2:
+            print("Passwords didn't match!")
     user = ohmyapi_auth.models.User(email=email, username=username, is_staff=True, is_admin=True)
-    user.set_password(password)
+    user.set_password(password1)
     asyncio.run(project.init_orm())
     asyncio.run(user.save())
     asyncio.run(project.close_orm())

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

@@ -0,0 +1,17 @@
+from ohmyapi.router import APIRouter
+
+from . import models
+
+# 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 }}",
+    }
+

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

@@ -1,13 +0,0 @@
-from ohmyapi.router import APIRouter
-from . import models
-
-router = APIRouter(prefix="/{{ app_name }}")
-
-
-@router.get("/")
-def ping():
-    return {
-        "project": "{{ project_name }}",
-        "app": "{{ app_name }}",
-    }
-