ohmyapi 0.1.23__py3-none-any.whl → 0.1.25__py3-none-any.whl

ohmyapi/builtin/auth/routes.py

@@ -64,9 +64,7 @@ class TokenType(str, Enum):
     refresh = "refresh"
 
 
-def claims(
-    token_type: TokenType, user: User, groups: List[Group] = []
-) -> Claims:
+def claims(token_type: TokenType, user: User, groups: List[Group] = []) -> Claims:
     return Claims(
         type=token_type,
         sub=str(user.id),
@@ -83,7 +81,7 @@ def claims(
 
 def create_token(claims: Claims, expires_in: int) -> str:
     to_encode = claims.model_dump()
-    to_encode['exp'] = int(time.time()) + expires_in
+    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")

ohmyapi/builtin/demo/models.py

@@ -10,9 +10,9 @@ class Team(Model):
     id: UUID = field.data.UUIDField(primary_key=True)
     name: str = field.TextField()
     members: field.ManyToManyRelation[User] = field.ManyToManyField(
-        'ohmyapi_auth.User',
+        "ohmyapi_auth.User",
         related_name="tournament_teams",
-        through='user_tournament_teams',
+        through="user_tournament_teams",
     )
 
     def __str__(self):
@@ -32,19 +32,19 @@ 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',
+        "ohmyapi_demo.Tournament",
+        related_name="events",
     )
     participants: field.ManyToManyRelation[Team] = field.ManyToManyField(
-        'ohmyapi_demo.Team',
-        related_name='events',
-        through='event_team',
+        "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']
+        exclude = ["tournament_id"]
 
     def __str__(self):
         return self.name

ohmyapi/builtin/demo/routes.py

@@ -11,37 +11,41 @@ from typing import List
 router = APIRouter(prefix="/tournemant")
 
 
-@router.get("/",
-            tags=["tournament"],
-            response_model=List[models.Tournament.Schema.model])
+@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(Tournament.all())
+    return await models.Tournament.Schema.model.from_queryset(models.Tournament.all())
 
 
-@router.post("/",
-             tags=["tournament"],
-             status_code=HTTPStatus.CREATED)
+@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()))
+    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)
+@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))
+    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)
+@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()))
+    return await models.Tournament.Schema.model.from_queryset(
+        models.Tournament.update(**tournament.model_dump())
+    )
 
 
 @router.delete("/{id}", tags=["tournament"])
@@ -51,4 +55,3 @@ async def delete(id: str):
         return await tournament.delete()
     except DoesNotExist:
         raise HTTPException(status_code=HTTPStatus.NOT_FOUND, detail="not found")
-

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

@@ -4,13 +4,16 @@ 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("/")
 async def list():
     """List all ..."""

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/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.23.dist-info → ohmyapi-0.1.25.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ohmyapi
-Version: 0.1.23
+Version: 0.1.25
 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
 
 ---
 
@@ -65,7 +62,7 @@ It is ***blazingly fast***, ***fun to use*** and comes with ***batteries include
 **Creating a Project**
 
 ```
-pip install ohmyapi
+pipx install ohmyapi
 ohmyapi startproject myproject
 cd myproject
 ```
@@ -162,24 +159,29 @@ from ohmyapi.db.exceptions import DoesNotExist
 
 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("/")
 async def list():
     queryset = Tournament.all()
     return await Tournament.Schema.model.from_queryset(queryset)
 
 
-@router.post("/", status_code=HTTPStatus.CREATED)
+@tournament_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")
+@tournament_router.get("/:id")
 async def get(id: str):
     try:
         queryset = Tournament.get(id=id)
@@ -187,6 +189,16 @@ async def get(id: str):
     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")
+
+
 ...
 ```
 

{ohmyapi-0.1.23.dist-info → ohmyapi-0.1.25.dist-info}/RECORD

@@ -3,26 +3,26 @@ 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=e6i9AanJqj1RK8VQVXwNV-Pv8R3X8I70SgaDtbCYUIE,6318
+ohmyapi/builtin/auth/routes.py,sha256=rhQJ1GnBJctB6jrKAl415bwoaMFypDqoVQ9ZpHyi9v4,6312
 ohmyapi/builtin/demo/__init__.py,sha256=k1rGtOmMPVZJ1fMPELY0v3k70WyzSp18pstJTkCdFr0,42
-ohmyapi/builtin/demo/models.py,sha256=8Id0dHPuow_Dtt_337UV3VTxvtVAllaVeImvstqiqdE,1403
-ohmyapi/builtin/demo/routes.py,sha256=MQaPCz43v4kTv9_oz44up1j77Ra1SqSN9i3vN26xllU,1843
+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
+ohmyapi/core/runtime.py,sha256=i-yeFN_mwk2EIisKWM78yO09lPvApX9J_gr_OXmXlGc,9553
 ohmyapi/core/scaffolding.py,sha256=SA0SYFd7VcqkOn9xuXgj-yOoVqCZMJo68GGFbm34GE4,2663
 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=dFpmfrfN1pwOsD6MAa_MmI7aP4kKJ2ZiijobWHsfyDs,873
+ohmyapi/core/templates/app/routes.py.j2,sha256=HQOf_9VqMgP3CCtf5IHNePubomiWKEf8D6qed33uLBI,948
 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
+ohmyapi/core/templates/project/pyproject.toml.j2,sha256=3ZqO6FX9Bhq8OAZl8nHPXCiWxl3gAffIF-LsC_-K9Us,538
+ohmyapi/core/templates/project/settings.py.j2,sha256=So6w1OiL_jU-FyeT8IHueDjGNuEoSkYhabhHpne2fUU,140
 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=6Exv6sVPVyiIYxxAQbxQhFRX74MKTUPWXIBwC7UZ-ww,82
-ohmyapi-0.1.23.dist-info/METADATA,sha256=HPmvXFChCOfKmKOn6u6JlcItr_2_UrXk9MoA7aCBl2Y,9727
-ohmyapi-0.1.23.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
-ohmyapi-0.1.23.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
-ohmyapi-0.1.23.dist-info/RECORD,,
+ohmyapi-0.1.25.dist-info/METADATA,sha256=diqmmkix3alQdWz3CHtZBvOZeFMPJHGJsx6-UTRSN1U,10040
+ohmyapi-0.1.25.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
+ohmyapi-0.1.25.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
+ohmyapi-0.1.25.dist-info/RECORD,,