ohmyapi 0.1.11__tar.gz → 0.1.13__tar.gz

{ohmyapi-0.1.11 → ohmyapi-0.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ohmyapi
-Version: 0.1.11
+Version: 0.1.13
 Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
 License-Expression: MIT
 Keywords: fastapi,tortoise,orm,async,web-framework
@@ -267,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,
@@ -276,7 +274,7 @@ from ohmyapi_auth import (
 
 from .models import Tournament
 
-router = APIRouter(prefix="/tournament")
+router = APIRouter(prefix="/tournament", tags=["Tournament"])
 
 
 @router.get("/")
@@ -294,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()
 
 
@@ -308,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.
@@ -336,12 +353,17 @@ Out[2]:
  Routes:
   - APIRoute(path='/auth/login', name='login', methods=['POST'])
   - APIRoute(path='/auth/refresh', name='refresh_token', methods=['POST'])
-  - APIRoute(path='/auth/me', name='me', methods=['GET'])
-  - APIRoute(path='/auth/introspect', name='introspect', methods=['GET'])}
+  - 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
-Out[3]:
-
 ```
 
 

{ohmyapi-0.1.11 → ohmyapi-0.1.13}/README.md

@@ -235,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,
@@ -244,7 +242,7 @@ from ohmyapi_auth import (
 
 from .models import Tournament
 
-router = APIRouter(prefix="/tournament")
+router = APIRouter(prefix="/tournament", tags=["Tournament"])
 
 
 @router.get("/")
@@ -262,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()
 
 
@@ -276,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.
@@ -304,11 +321,16 @@ Out[2]:
  Routes:
   - APIRoute(path='/auth/login', name='login', methods=['POST'])
   - APIRoute(path='/auth/refresh', name='refresh_token', methods=['POST'])
-  - APIRoute(path='/auth/me', name='me', methods=['GET'])
-  - APIRoute(path='/auth/introspect', name='introspect', methods=['GET'])}
+  - 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
-Out[3]:
-
 ```
 

{ohmyapi-0.1.11 → ohmyapi-0.1.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ohmyapi"
-version = "0.1.11"
+version = "0.1.13"
 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.11 → ohmyapi-0.1.13}/src/ohmyapi/cli.py

@@ -1,4 +1,5 @@
 import asyncio
+import atexit
 import importlib
 import sys
 import typer
@@ -16,13 +17,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)
 
 
@@ -45,6 +46,28 @@ def shell(root: str = "."):
     project_path = Path(root).resolve()
     project = runtime.Project(project_path)
 
+    # Ensure the ORM is shutdown
+    async def close_project():
+        try:
+            await project.close_orm()
+            print("Tortoise ORM closed successfully.")
+        except Exception as e:
+            print(f"Error closing ORM: {e}")
+
+    def cleanup():
+        loop = None
+        try:
+            loop = asyncio.get_running_loop()
+        except RuntimeError:
+            pass
+        if loop and loop.is_running():
+            asyncio.create_task(close_project())
+        else:
+            asyncio.run(close_project())
+
+    # Ensure the ORM is initialized
+    asyncio.run(project.init_orm())
+
     try:
         from IPython import start_ipython
         shell_vars = {
@@ -56,11 +79,13 @@ def shell(root: str = "."):
         c.TerminalInteractiveShell.banner2 = banner.format(**{
             "project_name": f"{f'{project.settings.PROJECT_NAME} ' if getattr(project.settings, 'PROJECT_NAME', '') else ''}[{Path(project_path).resolve()}]",
         })
+        atexit.register(cleanup)
         start_ipython(argv=[], user_ns=shell_vars, config=c)
     except ImportError:
         typer.echo("IPython is not installed. Falling back to built-in Python shell.")
         import code
-        code.interact(local={"settings": project.settings})
+        atexit.register(cleanup)
+        code.interact(local={"p": project})
 
 
 @app.command()
@@ -93,6 +118,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 +132,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())