ohmyapi 0.1.10__py3-none-any.whl → 0.1.12__py3-none-any.whl

ohmyapi/builtin/auth/permissions.py

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

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/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/core/templates/app/routes.py.j2

@@ -1,11 +1,15 @@
 from ohmyapi.router import APIRouter
+
 from . import models
 
-router = APIRouter(prefix="/{{ app_name }}")
+# 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 ping():
+def hello_world():
     return {
         "project": "{{ project_name }}",
         "app": "{{ app_name }}",

{ohmyapi-0.1.10.dist-info → ohmyapi-0.1.12.dist-info}/METADATA

@@ -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.dist-info → ohmyapi-0.1.12.dist-info}/RECORD

@@ -2,15 +2,15 @@ ohmyapi/__init__.py,sha256=UmLNQImTbKvHEgwQB2Wsyl6fq88X92imL9QZYJpQX4I,18
 ohmyapi/__main__.py,sha256=wcCrL4PjG51r5wVKqJhcoJPTLfHW0wNbD31DrUN0MWI,28
 ohmyapi/builtin/auth/__init__.py,sha256=TY1RKgwWmJ6FKz_v4J3m0Ang69qSmtVDLe4rqjLk4-E,69
 ohmyapi/builtin/auth/models.py,sha256=Xsxn9m5RTgY2a0PPfW3wTj77ocuuISytdl4ec_TR_kw,1524
-ohmyapi/builtin/auth/permissions.py,sha256=NKljLhgEHcEIlzpWgqFyz-1PeCT2u0Vqkja4xy-Zj68,126
-ohmyapi/builtin/auth/routes.py,sha256=DxlVzHSdMIbKMnWXMMGj_M-jUMFLHTt8avzBviM7Ia0,5625
-ohmyapi/cli.py,sha256=ZJVBRpSS297y00H4zffYQzkeIIVmVpGS4BYGpxT1FPo,3430
+ohmyapi/builtin/auth/permissions.py,sha256=jf-I2b9rIOw2EF4Kga-_Bz1ZPPHU0vHNaXGrDQSwhSI,145
+ohmyapi/builtin/auth/routes.py,sha256=iMxmgP6TSpMrtSKf-g7mc60NcOiw8FRkngUroalGCyk,5519
+ohmyapi/cli.py,sha256=qCGi9GtgybCh_jb_NVwu9dlG9XTbilg6qnXop2IIgC8,3768
 ohmyapi/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ohmyapi/core/runtime.py,sha256=l5zffc4VTwQOo7G9mfiYHsPGapMONRX_jtO_z9QaKHU,8577
 ohmyapi/core/scaffolding.py,sha256=iMymscokJ-YqzB0ZTC-gcc2T71o73577j9tnb2x8lH8,2572
 ohmyapi/core/templates/app/__init__.py.j2,sha256=QwVIQVUGZVhdH1d4NrvL7NTsK4-T4cihzYs8UVX2dt4,43
 ohmyapi/core/templates/app/models.py.j2,sha256=_3w-vFJ5fgsmncsCv34k_wyCMF78jufbSSglns4gbb0,119
-ohmyapi/core/templates/app/routes.py.j2,sha256=Ee3xeVdM_G5-TRw14_C6siJTrEXtnRUD5xhcHCbu5QA,229
+ohmyapi/core/templates/app/routes.py.j2,sha256=o3XEBZDfHRhodx-6rX1ebnKpqqd-QApfw9ggruWl6y8,436
 ohmyapi/core/templates/project/README.md.j2,sha256=SjR4JIrg-8XRE-UntUDwiw8jDpYitD_UjwoKkYJ7GLw,22
 ohmyapi/core/templates/project/pyproject.toml.j2,sha256=X0VS6YT9aL3vpHFKPTfLFsdpD8423nY57ySQpSTMxmQ,895
 ohmyapi/core/templates/project/settings.py.j2,sha256=RBKGB8MZWPM3Bp0a57Y1YrSvSXxh502TUnJqbbu48Ig,138
@@ -19,7 +19,7 @@ ohmyapi/db/exceptions.py,sha256=I7AubrdqQF_UvAvzKqz2ve08-BkXHzEWXnwG300StHE,35
 ohmyapi/db/model/__init__.py,sha256=k3StTNuKatpwZo_Z5JBFa-927eJrzibFE8U4SA82asc,32
 ohmyapi/db/model/model.py,sha256=BajFtLlQ1s0mZ2hj-_JNQhLQmxuVe-Lw2LuW5t2C7Rw,1579
 ohmyapi/router.py,sha256=hutccsrP9RT8W5O6uBDhOJehwqrkRoPzaUI5zoHPh9A,55
-ohmyapi-0.1.10.dist-info/METADATA,sha256=xffjsR7JBYq5U17kPIbznhmp0cuwDPIJRtDKhLmSEtM,8038
-ohmyapi-0.1.10.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
-ohmyapi-0.1.10.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
-ohmyapi-0.1.10.dist-info/RECORD,,
+ohmyapi-0.1.12.dist-info/METADATA,sha256=i8wVhc1RwYUKSXXQmffQCMcuawbKmD07yu48rxK3zOY,8673
+ohmyapi-0.1.12.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
+ohmyapi-0.1.12.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
+ohmyapi-0.1.12.dist-info/RECORD,,