ohmyapi 0.1.22__py3-none-any.whl → 0.1.24__py3-none-any.whl

ohmyapi/builtin/auth/routes.py

@@ -26,9 +26,62 @@ REFRESH_TOKEN_EXPIRE_SECONDS = getattr(
 oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/auth/login")
 
 
-def create_token(data: dict, expires_in: int) -> str:
-    to_encode = data.copy()
-    to_encode.update({"exp": int(time.time()) + expires_in})
+class ClaimsUser(BaseModel):
+    username: str
+    email: str
+    is_admin: bool
+    is_staff: bool
+
+
+class Claims(BaseModel):
+    type: str
+    sub: str
+    user: ClaimsUser
+    roles: List[str]
+    exp: str
+
+
+class AccessToken(BaseModel):
+    token_type: str
+    access_token: str
+
+
+class RefreshToken(AccessToken):
+    refresh_token: str
+
+
+class LoginRequest(BaseModel):
+    username: str
+    password: str
+
+
+class TokenType(str, Enum):
+    """
+    Helper for indicating the token type when generating claims.
+    """
+
+    access = "access"
+    refresh = "refresh"
+
+
+def claims(token_type: TokenType, user: User, groups: List[Group] = []) -> Claims:
+    return Claims(
+        type=token_type,
+        sub=str(user.id),
+        user=ClaimsUser(
+            username=user.username,
+            email=user.email,
+            is_admin=user.is_admin,
+            is_staff=user.is_staff,
+        ),
+        roles=[g.name for g in groups],
+        exp="",
+    )
+
+
+def create_token(claims: Claims, expires_in: int) -> str:
+    to_encode = claims.model_dump()
+    to_encode["exp"] = int(time.time()) + expires_in
     token = jwt.encode(to_encode, JWT_SECRET, algorithm=JWT_ALGORITHM)
     if isinstance(token, bytes):
         token = token.decode("utf-8")
@@ -48,29 +101,6 @@ def decode_token(token: str) -> Dict:
         )
 
 
-class TokenType(str, Enum):
-    """
-    Helper for indicating the token type when generating claims.
-    """
-
-    access = "access"
-    refresh = "refresh"
-
-
-def claims(
-    token_type: TokenType, user: User, groups: List[Group] = []
-) -> Dict[str, Any]:
-    return {
-        "type": token_type,
-        "sub": str(user.id),
-        "user": {
-            "username": user.username,
-            "email": user.email,
-        },
-        "roles": [g.name for g in groups],
-    }
-
-
 async def get_token(token: str = Depends(oauth2_scheme)) -> Dict:
     """Dependency: token introspection"""
     payload = decode_token(token)
@@ -127,12 +157,7 @@ async def require_group(
     return current_user
 
 
-class LoginRequest(BaseModel):
-    username: str
-    password: str
-
-
-@router.post("/login")
+@router.post("/login", response_model=RefreshToken)
 async def login(form_data: LoginRequest = Body(...)):
     """Login with username & password, returns access and refresh tokens."""
     user = await User.authenticate(form_data.username, form_data.password)
@@ -148,14 +173,14 @@ async def login(form_data: LoginRequest = Body(...)):
         claims(TokenType.refresh, user), REFRESH_TOKEN_EXPIRE_SECONDS
     )
 
-    return {
-        "access_token": access_token,
-        "refresh_token": refresh_token,
-        "token_type": "bearer",
-    }
+    return RefreshToken(
+        token_type="bearer",
+        access_token=access_token,
+        refresh_token=refresh_token,
+    )
 
 
-@router.post("/refresh")
+@router.post("/refresh", response_model=AccessToken)
 async def refresh_token(refresh_token: str):
     """Exchange refresh token for new access token."""
     payload = decode_token(refresh_token)
@@ -174,15 +199,15 @@ async def refresh_token(refresh_token: str):
     new_access = create_token(
         claims(TokenType.access, user), ACCESS_TOKEN_EXPIRE_SECONDS
     )
-    return {"access_token": new_access, "token_type": "bearer"}
+    return AccessToken(token_type="bearer", access_token=access_token)
 
 
-@router.get("/introspect")
+@router.get("/introspect", response_model=Dict[str, Any])
 async def introspect(token: Dict = Depends(get_token)):
     return token
 
 
-@router.get("/me")
+@router.get("/me", response_model=User.Schema.model)
 async def me(user: User = Depends(get_current_user)):
     """Return the currently authenticated user."""
-    return User.Schema.one.from_orm(user)
+    return await User.Schema.model.from_tortoise_orm(user)

ohmyapi/builtin/demo/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from . import routes

ohmyapi/builtin/demo/models.py

@@ -0,0 +1,50 @@
+from ohmyapi.db import Model, field
+from ohmyapi_auth.models import User
+
+from datetime import datetime
+from decimal import Decimal
+from uuid import UUID
+
+
+class Team(Model):
+    id: UUID = field.data.UUIDField(primary_key=True)
+    name: str = field.TextField()
+    members: field.ManyToManyRelation[User] = field.ManyToManyField(
+        "ohmyapi_auth.User",
+        related_name="tournament_teams",
+        through="user_tournament_teams",
+    )
+
+    def __str__(self):
+        return self.name
+
+
+class Tournament(Model):
+    id: UUID = field.data.UUIDField(primary_key=True)
+    name: str = field.TextField()
+    created: datetime = field.DatetimeField(auto_now_add=True)
+
+    def __str__(self):
+        return self.name
+
+
+class Event(Model):
+    id: UUID = field.data.UUIDField(primary_key=True)
+    name: str = field.TextField()
+    tournament: field.ForeignKeyRelation[Tournament] = field.ForeignKeyField(
+        "ohmyapi_demo.Tournament",
+        related_name="events",
+    )
+    participants: field.ManyToManyRelation[Team] = field.ManyToManyField(
+        "ohmyapi_demo.Team",
+        related_name="events",
+        through="event_team",
+    )
+    modified: datetime = field.DatetimeField(auto_now=True)
+    prize: Decimal = field.DecimalField(max_digits=10, decimal_places=2, null=True)
+
+    class Schema:
+        exclude = ["tournament_id"]
+
+    def __str__(self):
+        return self.name

ohmyapi/builtin/demo/routes.py

@@ -0,0 +1,57 @@
+from ohmyapi.router import APIRouter, HTTPException, HTTPStatus
+from ohmyapi.db.exceptions import DoesNotExist
+
+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="/tournemant")
+
+
+@router.get(
+    "/", tags=["tournament"], response_model=List[models.Tournament.Schema.model]
+)
+async def list():
+    """List all tournaments."""
+    return await models.Tournament.Schema.model.from_queryset(models.Tournament.all())
+
+
+@router.post("/", tags=["tournament"], status_code=HTTPStatus.CREATED)
+async def post(tournament: models.Tournament.Schema.readonly):
+    """Create tournament."""
+    return await models.Tournament.Schema.model.from_queryset(
+        models.Tournament.create(**tournament.model_dump())
+    )
+
+
+@router.get("/{id}", tags=["tournament"], response_model=models.Tournament.Schema.model)
+async def get(id: str):
+    """Get tournament by id."""
+    return await models.Tournament.Schema.model.from_queryset(
+        models.Tournament.get(id=id)
+    )
+
+
+@router.put(
+    "/{id}",
+    tags=["tournament"],
+    response_model=models.Tournament.Schema.model,
+    status_code=HTTPStatus.ACCEPTED,
+)
+async def put(tournament: models.Tournament.Schema.model):
+    """Update tournament."""
+    return await models.Tournament.Schema.model.from_queryset(
+        models.Tournament.update(**tournament.model_dump())
+    )
+
+
+@router.delete("/{id}", tags=["tournament"])
+async def delete(id: str):
+    try:
+        tournament = await models.Tournament.get(id=id)
+        return await tournament.delete()
+    except DoesNotExist:
+        raise HTTPException(status_code=HTTPStatus.NOT_FOUND, detail="not found")

ohmyapi/core/templates/project/pyproject.toml.j2

@@ -10,18 +10,7 @@ readme = "README.md"
 license = { text = "MIT" }
 
 dependencies = [
-    "typer >=0.19.1,<0.20.0",
-    "jinja2 >=3.1.6,<4.0.0",
-    "fastapi >=0.117.1,<0.118.0",
-    "tortoise-orm >=0.25.1,<0.26.0",
-    "aerich >=0.9.1,<0.10.0",
-    "uvicorn >=0.36.0,<0.37.0",
-    "ipython >=9.5.0,<10.0.0",
-    "passlib >=1.7.4,<2.0.0",
-    "pyjwt >=2.10.1,<3.0.0",
-    "python-multipart >=0.0.20,<0.0.21",
-    "crypto >=1.4.1,<2.0.0",
-    "argon2-cffi >=25.1.0,<26.0.0",
+    "ohmyapi (>=0.1.0,<0.2.0)"
 ]
 
 [tool.poetry.group.dev.dependencies]

ohmyapi/router.py

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

{ohmyapi-0.1.22.dist-info → ohmyapi-0.1.24.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ohmyapi
-Version: 0.1.22
+Version: 0.1.24
 Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
 License-Expression: MIT
 Keywords: fastapi,tortoise,orm,async,web-framework
@@ -34,29 +34,26 @@ Description-Content-Type: text/markdown
 
 > Think: Django RestFramework, but less clunky and 100% async.
 
-OhMyAPI is a Django-flavored web-application scaffolding framework and management layer.
-Built around FastAPI and TortoiseORM, it is 100% async.
+OhMyAPI is a Django-flavored web-application scaffolding framework and management layer,
+built around FastAPI and TortoiseORM and is thus 100% async.
 
-It is ***blazingly fast***, ***fun to use*** and comes with ***batteries included***!
+It is ***blazingly fast***, extremely ***fun to use*** and comes with ***batteries included***!
 
 **Features**
 
-- Django-like project-layout and -structure
-- Django-like project-level settings.py
-- Django-like models via TortoiseORM
-- Django-like `Model.Meta` class for model configuration
-- Easily convert your query results to `pydantic` models via `Model.Schema`
-- Django-like migrations (`makemigrations` & `migrate`) via Aerich
+- 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)
-- Various optional builtin apps you can hook into your project
+- Customizable pydantic model serializer built-in 
+- Various optional built-in apps you can hook into your project
 - Highly configurable and customizable
 - 100% async
 
 **Goals**
 
-- combine FastAPI, TortoiseORM and Aerich migrations into a high-productivity web-application framework
-- tie everything neatly together into a concise API
-- while ***AVOIDING*** any additional abstractions ontop of Tortoise's model-system or FastAPI's routing system
+- 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
 
 ---
 

{ohmyapi-0.1.22.dist-info → ohmyapi-0.1.24.dist-info}/RECORD

@@ -3,7 +3,10 @@ ohmyapi/__main__.py,sha256=wcCrL4PjG51r5wVKqJhcoJPTLfHW0wNbD31DrUN0MWI,28
 ohmyapi/builtin/auth/__init__.py,sha256=vOVCSJX8BALzs8h5ZW9507bjoscP37bncMjdMmBXcMM,42
 ohmyapi/builtin/auth/models.py,sha256=Fggg3GDVydKoZQOlXXNDsWKxehvsp8BXC1xedv0Qr34,1729
 ohmyapi/builtin/auth/permissions.py,sha256=mxsnhF_UGesTFle7v1JHORkNODtQ0qanAL3FtOcMCEY,145
-ohmyapi/builtin/auth/routes.py,sha256=faVs9FuldubEcA3N335OvNGwiMUBjGxHf4IzIUQhV8o,5744
+ohmyapi/builtin/auth/routes.py,sha256=rhQJ1GnBJctB6jrKAl415bwoaMFypDqoVQ9ZpHyi9v4,6312
+ohmyapi/builtin/demo/__init__.py,sha256=k1rGtOmMPVZJ1fMPELY0v3k70WyzSp18pstJTkCdFr0,42
+ohmyapi/builtin/demo/models.py,sha256=N3LnHLEa5wYBvaQBImCR4SdZvRYGuwM_iyLCeh9QY8s,1403
+ohmyapi/builtin/demo/routes.py,sha256=DQ-wO9O0lTJkYqAjVSp0jBs9pavs5vS9IlHXRePU-Ng,1806
 ohmyapi/cli.py,sha256=dJVNgpW5S4rCc619AEEKBKuEIAmQs153Ls0ZVaea48w,4173
 ohmyapi/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ohmyapi/core/runtime.py,sha256=i4dI7mC59rw0blMOeVGawUm8v5id3ZllLlP8RLo1GT0,9419
@@ -12,14 +15,14 @@ ohmyapi/core/templates/app/__init__.py.j2,sha256=QwVIQVUGZVhdH1d4NrvL7NTsK4-T4ci
 ohmyapi/core/templates/app/models.py.j2,sha256=_3w-vFJ5fgsmncsCv34k_wyCMF78jufbSSglns4gbb0,119
 ohmyapi/core/templates/app/routes.py.j2,sha256=dFpmfrfN1pwOsD6MAa_MmI7aP4kKJ2ZiijobWHsfyDs,873
 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/pyproject.toml.j2,sha256=3ZqO6FX9Bhq8OAZl8nHPXCiWxl3gAffIF-LsC_-K9Us,538
 ohmyapi/core/templates/project/settings.py.j2,sha256=RBKGB8MZWPM3Bp0a57Y1YrSvSXxh502TUnJqbbu48Ig,138
 ohmyapi/db/__init__.py,sha256=5QKUycxnN83DOUD_Etoee9tEOYjnZ74deqrSOOx_MiQ,204
 ohmyapi/db/exceptions.py,sha256=vb4IIUoeYAY6sK42zRtjMy-39IFVi_Qb6mWySTY0jYw,34
 ohmyapi/db/model/__init__.py,sha256=k3StTNuKatpwZo_Z5JBFa-927eJrzibFE8U4SA82asc,32
 ohmyapi/db/model/model.py,sha256=WTf41ByCtfk9c_O6QCsO9KA0avHL3zGMZ6SEdw5GOuc,2420
-ohmyapi/router.py,sha256=LDxOyiqSb5zVU9zCxi014Ad4DKPZn6V8o9u0WfpmgdE,83
-ohmyapi-0.1.22.dist-info/METADATA,sha256=NrxMn9DH5ydLr6Aui5yN4svdRP9UiuKT5GqzJ8XMuaU,9727
-ohmyapi-0.1.22.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
-ohmyapi-0.1.22.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
-ohmyapi-0.1.22.dist-info/RECORD,,
+ohmyapi/router.py,sha256=6Exv6sVPVyiIYxxAQbxQhFRX74MKTUPWXIBwC7UZ-ww,82
+ohmyapi-0.1.24.dist-info/METADATA,sha256=YbyF-6_5QGYVomyCh_BJWzN8IKGqBBTQ6O342yjwY8E,9626
+ohmyapi-0.1.24.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
+ohmyapi-0.1.24.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
+ohmyapi-0.1.24.dist-info/RECORD,,