ohmyapi 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

ohmyapi/__main__.py

@@ -0,0 +1,3 @@
+from .cli import app
+
+app()

ohmyapi/cli.py

@@ -109,6 +109,3 @@ def createsuperuser(root: str = "."):
     asyncio.run(user.save())
     asyncio.run(project.close_orm())
 
-def main():
-    app()
-

ohmyapi/core/templates/project/README.md.j2

@@ -0,0 +1,2 @@
+# {{ project_name }}
+

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

@@ -1,13 +1,37 @@
-[tool.poetry]
+[project]
 name = "{{ project_name }}"
 version = "0.1.0"
 description = "OhMyAPI project"
-authors = ["You <you@example.com>"]
+authors = [
+    { name = "You", email = "you@you.tld" }
+]
+requires-python = ">=3.13"
+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",
+]
+
+[tool.poetry.group.dev.dependencies]
+ipython = ">=9.5.0,<10.0.0"
 
-[tool.poetry.dependencies]
-python = "^3.10"
-fastapi = "^0.115"
-uvicorn = "^0.30"
-tortoise-orm = "^0.20"
-aerich = "^0.7"
+[project.optional-dependencies]
+auth = ["passlib", "pyjwt", "crypto", "argon2-cffi", "python-multipart"]
+
+[tool.poetry]
+package-mode = false
 
+[project.scripts]
+{{ project_name }} = "ohmyapi.cli:app"

ohmyapi/db/__init__.py

@@ -1,3 +1,3 @@
-from tortoise import fields as field
-from .model import Model
+from .model import Model, field
+from tortoise.manager import Manager
 

ohmyapi/db/exceptions.py

@@ -0,0 +1,2 @@
+from tortoise.exceptions import *
+

ohmyapi/db/model/__init__.py

@@ -1 +1 @@
-from .model import Model, fields
+from .model import Model, field

ohmyapi/db/model/model.py

@@ -1,4 +1,4 @@
-from tortoise import fields
+from tortoise import fields as field
 from tortoise.models import Model as TortoiseModel
 from tortoise.contrib.pydantic import pydantic_model_creator, pydantic_queryset_creator
 

ohmyapi/router.py

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

ohmyapi-0.1.7.dist-info/METADATA

@@ -0,0 +1,310 @@
+Metadata-Version: 2.4
+Name: ohmyapi
+Version: 0.1.7
+Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
+License-Expression: MIT
+Keywords: fastapi,tortoise,orm,async,web-framework
+Author: Brian Wiborg
+Author-email: me@brianwib.org
+Requires-Python: >=3.13
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: auth
+Requires-Dist: aerich (>=0.9.1,<0.10.0)
+Requires-Dist: argon2-cffi (>=25.1.0,<26.0.0)
+Requires-Dist: argon2-cffi ; extra == "auth"
+Requires-Dist: crypto (>=1.4.1,<2.0.0)
+Requires-Dist: crypto ; extra == "auth"
+Requires-Dist: fastapi (>=0.117.1,<0.118.0)
+Requires-Dist: ipython (>=9.5.0,<10.0.0)
+Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
+Requires-Dist: passlib (>=1.7.4,<2.0.0)
+Requires-Dist: passlib ; extra == "auth"
+Requires-Dist: pyjwt (>=2.10.1,<3.0.0)
+Requires-Dist: pyjwt ; extra == "auth"
+Requires-Dist: python-multipart (>=0.0.20,<0.0.21)
+Requires-Dist: python-multipart ; extra == "auth"
+Requires-Dist: tortoise-orm (>=0.25.1,<0.26.0)
+Requires-Dist: typer (>=0.19.1,<0.20.0)
+Requires-Dist: uvicorn (>=0.36.0,<0.37.0)
+Description-Content-Type: text/markdown
+
+# OhMyAPI
+
+> Think: Micro-Django, but API-first, 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.
+
+It is ***blazingly fast***, ***fun*** to use and comes with ***batteries included***!
+
+**Features**
+
+- Django-like project-layout and -structure
+- Django-like prject-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 CLI tooling (`startproject`, `startapp`, `shell`, `serve`, etc)
+- Various optional builtin apps you can hook into your project
+- Highly configurable and customizable
+- 100% async
+
+---
+
+## Getting started
+
+**Creating a Project**
+
+```
+pip install ohmyapi
+ohmyapi startproject myproject
+cd myproject
+```
+
+This will create the following directory structure:
+
+```
+myproject/
+  - pyproject.toml
+  - README.md
+  - settings.py
+```
+
+Run your project with:
+
+```
+ohmyapi serve
+```
+
+In your browser go to:
+- http://localhost:8000/docs
+
+**Creating an App**
+
+Create a new app by:
+
+```
+ohmyapi startapp tournament
+```
+
+This will create the following directory structure:
+
+```
+myproject/
+  - tournament/
+    - __init__.py
+    - models.py
+    - routes.py
+  - pyproject.toml
+  - README.md
+  - settings.py
+```
+
+Add 'tournament' to your `INSTALLED_APPS` in `settings.py`.
+
+### Models
+
+Write your first model in `turnament/models.py`:
+
+```python
+from ohmyapi.db import Model, field
+
+
+class Tournament(Model):
+    id = field.IntField(primary_key=True)
+    name = field.TextField()
+    created = field.DatetimeField(auto_now_add=True)
+
+    def __str__(self):
+        return self.name
+
+
+class Event(Model):
+    id = field.IntField(primary_key=True)
+    name = field.TextField()
+    tournament = field.ForeignKeyField('tournament.Tournament', related_name='events')
+    participants = field.ManyToManyField('torunament.Team', related_name='events', through='event_team')
+    modified = field.DatetimeField(auto_now=True)
+    prize = field.DecimalField(max_digits=10, decimal_places=2, null=True)
+
+    def __str__(self):
+        return self.name
+
+
+class Team(Model):
+    id = field.IntField(primary_key=True)
+    name = field.TextField()
+
+    def __str__(self):
+        return self.name
+```
+
+### API Routes
+
+Next, create your endpoints in `tournament/routes.py`:
+
+```python
+from ohmyapi.router import APIRouter, HTTPException
+from ohmyapi.db.exceptions import DoesNotExist
+
+from .models import Tournament
+
+router = APIRouter(prefix="/tournament")
+
+
+@router.get("/")
+async def list():
+    queryset = Tournament.all()
+    return await Tournament.Schema.many.from_queryset(queryset)
+
+
+@router.get("/:id")
+async def get(id: int):
+    try:
+        queryset = Tournament.get(pk=id)
+        return await Tournament.Schema.one(queryset)
+    except DoesNotExist:
+        raise HTTPException(status_code=404, detail="item not found")
+
+...
+```
+
+## Migrations
+
+Before we can run the app, we need to create and initialize the database.
+
+Similar to Django, first run:
+
+```
+ohmyapi makemigrations [ <app> ]  # no app means all INSTALLED_APPS
+```
+
+This will create a `migrations/` folder in you project root.
+
+```
+myproject/
+  - tournament/
+    - __init__.py
+    - models.py
+    - routes.py
+  - migrations/
+    - tournament/
+  - pyproject.toml
+  - README.md
+  - settings.py
+```
+
+Apply your migrations via:
+
+```
+ohmyapi migrate [ <app> ]  # no app means all INSTALLED_APPS
+```
+
+Run your project:
+
+```
+ohmyapi serve
+```
+
+## Shell
+
+Similar to Django, you can attach to an interactive shell with your project already loaded inside.
+
+```
+ohmyapi shell
+```
+
+## Authentication
+
+A builtin auth app is available.
+
+Simply add `ohmyapi_auth` to your INSTALLED_APPS and define a JWT_SECRET in your `settings.py`.
+Remember to `makemigrations` and `migrate` for the necessary tables to be created in the database.
+
+`settings.py`:
+
+```
+INSTALLED_APPS = [
+    'ohmyapi_auth',
+    ...
+]
+
+JWT_SECRET = "t0ps3cr3t"
+```
+
+After restarting your project you will have access to the `ohmyapi_auth` app.
+It comes with a `User` and `Group` model, as well as endpoints for JWT auth.
+
+You can use the models as `ForeignKeyField` in your application models:
+
+```python
+class Team(Model):
+    [...]
+    members = field.ManyToManyField('ohmyapi_auth.User', related_name='tournament_teams', through='tournament_teams')
+    [...]
+```
+
+Remember to run `makemigrations` and `migrate` in order for your model changes to take effect in the database.
+
+Create a super-user:
+
+```
+ohmyapi createsuperuser
+```
+
+## Permissions
+
+### API-Level Permissions
+
+Use FastAPI's `Depends` pattern to implement API-level access-control.
+
+
+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,
+)
+
+from .models import Tournament
+
+router = APIRouter(prefix="/tournament")
+
+
+@router.get("/")
+async def list(user: auth.User = Depends(permissions.require_authenticated)):
+    queryset = Tournament.all()
+    return await Tournament.Schema.many.from_queryset(queryset)
+
+
+...
+```
+
+### Model-Level Permissions
+
+Use Tortoise's `Manager` to implement model-layer permissions.
+
+```python
+from ohmyapi.db import Manager
+from typing import Callable
+
+
+class TeamManager(Manager):
+    async def for_user(self, user):
+        return await self.filter(members=user).all()
+
+
+class Team(Model):
+    [...]
+
+    class Meta:
+        manager = TeamManager()
+```
+

{ohmyapi-0.1.6.dist-info → ohmyapi-0.1.7.dist-info}/RECORD

@@ -1,22 +1,25 @@
 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=PjmRGdQA2uHh3qYODi58WzRdfCwHN4x4r9vlVF6eCqQ,1512
 ohmyapi/builtin/auth/permissions.py,sha256=gPBf01UNgXjU3v3DwMSYpKjayZSnwksp-ji4C99oX_I,111
 ohmyapi/builtin/auth/routes.py,sha256=5jLq92z4TJw4eyiIJ5t7MwRNtYlpN7suDwW28JeEQYA,4902
-ohmyapi/cli.py,sha256=DaSf1uYxv1bD1XBwVN_rn4F7hq9AlvXwtWzbVw7WPBw,3472
+ohmyapi/cli.py,sha256=gJIchYR4N4bo65DNePF_Oisksm2du4oAkOktJUiY1a4,3449
 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/project/pyproject.toml.j2,sha256=rk5baSS-nhW2mbdl60CHoXmeTBkqnzUEMwrRNxUnkt4,250
+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/db/__init__.py,sha256=p5oXqYUKT6eAoE-9JD-p6zKo9s-H84rJbrKxFna8Kvc,63
-ohmyapi/db/model/__init__.py,sha256=owKYpx5a2ZFTBgBqyEKN09AvY1cSP0dy1O7d3_sUVgM,33
-ohmyapi/db/model/model.py,sha256=PSzK_d8IZQExSRuTrEyPnqfa4GENQhbBZsVxxLWTR4g,1570
-ohmyapi/router.py,sha256=RzDXrtJJrk4eWdt9qoKBfz6g0S5WZq2hDQoFy5whR6A,40
-ohmyapi-0.1.6.dist-info/METADATA,sha256=aLe3O1xcYRb-a_WG6w4QkWxneATuaHjdmWZezxBcxhw,4268
-ohmyapi-0.1.6.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
-ohmyapi-0.1.6.dist-info/entry_points.txt,sha256=ZCZJLw_ojguyr1WOmb8UwHrr42hiLj6-Kzh4mMa_7Ns,44
-ohmyapi-0.1.6.dist-info/RECORD,,
+ohmyapi/db/__init__.py,sha256=PaDrioQ1lkFAo7Al82MoV6duQeJF0dTQ7EG0TzKOOIM,70
+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.7.dist-info/METADATA,sha256=C2rchwDu2l4Qw4oSqIfOz3P07f7yV2RanYoBzCD2khg,6841
+ohmyapi-0.1.7.dist-info/WHEEL,sha256=M5asmiAlL6HEcOq52Yi5mmk9KmTVjY2RDPtO4p9DMrc,88
+ohmyapi-0.1.7.dist-info/entry_points.txt,sha256=wb3lw8-meAlpiv1mqcQ3m25ukL7djagU_w89GkrC37k,43
+ohmyapi-0.1.7.dist-info/RECORD,,

ohmyapi-0.1.7.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+ohmyapi=ohmyapi.cli:app
+

ohmyapi-0.1.6.dist-info/METADATA

@@ -1,204 +0,0 @@
-Metadata-Version: 2.4
-Name: ohmyapi
-Version: 0.1.6
-Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
-License-Expression: MIT
-Keywords: fastapi,tortoise,orm,async,web-framework
-Author: Brian Wiborg
-Author-email: me@brianwib.org
-Requires-Python: >=3.13
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: aerich (>=0.9.1,<0.10.0)
-Requires-Dist: argon2-cffi (>=25.1.0,<26.0.0)
-Requires-Dist: crypto (>=1.4.1,<2.0.0)
-Requires-Dist: fastapi (>=0.117.1,<0.118.0)
-Requires-Dist: ipython (>=9.5.0,<10.0.0)
-Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
-Requires-Dist: passlib (>=1.7.4,<2.0.0)
-Requires-Dist: pyjwt (>=2.10.1,<3.0.0)
-Requires-Dist: python-multipart (>=0.0.20,<0.0.21)
-Requires-Dist: tortoise-orm (>=0.25.1,<0.26.0)
-Requires-Dist: typer (>=0.19.1,<0.20.0)
-Requires-Dist: uvicorn (>=0.36.0,<0.37.0)
-Description-Content-Type: text/markdown
-
-# OhMyAPI
-
-> OhMyAPI == Application scaffolding for FastAPI+TortoiseORM.
-
-OhMyAPI is a Django-flavored web-application scaffolding framework.
-Built around FastAPI and TortoiseORM, it 100% async.
-It is blazingly fast and has batteries included.
-
-Features:
-
-- Django-like project-layout and -structure
-- Django-like settings.py
-- Django-like models via TortoiseORM
-- Django-like model.Meta class for model configuration
-- Django-like advanced permissions system
-- Django-like migrations (makemigrations & migrate) via Aerich
-- Django-like CLI for interfacing with your projects (startproject, startapp, shell, serve, etc)
-- various optional builtin apps
-- highly configurable and customizable
-- 100% async
-
-## Getting started
-
-**Creating a Project**
-
-```
-pip install ohmyapi
-ohmyapi startproject myproject
-cd myproject
-```
-
-This will create the following directory structure:
-
-```
-myproject/
-  - pyproject.toml
-  - settings.py
-```
-
-Run your project with:
-
-```
-ohmyapi serve
-```
-
-In your browser go to:
-- http://localhost:8000/docs
-
-**Creating an App**
-
-Create a new app by:
-
-```
-ohmyapi startapp myapp
-```
-
-This will lead to the following directory structure:
-
-```
-myproject/
-  - myapp/
-    - __init__.py
-    - models.py
-    - routes.py
-  - pyproject.toml
-  - settings.py
-```
-
-Add 'myapp' to your `INSTALLED_APPS` in `settings.py`.
-
-Write your first model in `myapp/models.py`:
-
-```python
-from ohmyapi.db import Model, field
-
-
-class Person(Model):
-    id: int = field.IntField(min=1, pk=True)
-    name: str = field.CharField(min_length=1, max_length=255)
-    username: str = field.CharField(min_length=1, max_length=255, unique=True)
-    age: int = field.IntField(min=0)
-```
-
-Next, create your endpoints in `myapp/routes.py`:
-
-```python
-from fastapi import APIRouter, HTTPException
-from tortoise.exceptions import DoesNotExist
-
-from .models import Person
-
-router = APIRouter(prefix="/myapp")
-
-
-@router.get("/")
-async def list():
-    return await Person.Schema.many.from_queryset(Person.all())
-
-
-@router.get("/:id")
-async def get(id: int):
-    try:
-        return await Person.Schema.one(Person.get(pk=id))
-    except DoesNotExist:
-        raise HTTPException(status_code=404, detail="item not found")
-
-...
-```
-
-## Migrations
-
-Before we can run the app, we need to create and initialize the database.
-
-Similar to Django, first run:
-
-```
-ohmyapi makemigrations [ <app> ]  # no app means all INSTALLED_APPS
-```
-
-This will create a `migrations/` folder in you project root.
-
-```
-myproject/
-  - myapp/
-    - __init__.py
-    - models.py
-    - routes.py
-  - migrations/
-    - myapp/
-  - pyproject.toml
-  - settings.py
-```
-
-Apply your migrations via:
-
-```
-ohmyapi migrate [ <app> ]  # no app means all INSTALLED_APPS
-```
-
-Run your project:
-
-```
-ohmyapi serve
-```
-
-## Shell
-
-Similar to Django, you can attach to an interactive shell with your project already loaded inside.
-
-```
-ohmyapi shell
-```
-
-## Authentication
-
-A builtin auth app is available.
-
-Simply add `ohmyapi_auth` to your INSTALLED_APPS and define a JWT_SECRET in your `settings.py`.
-Remember to `makemigrations` and `migrate` for the auth tables to be created in the database.
-
-`settings.py`:
-
-```
-INSTALLED_APPS = [
-    'ohmyapi_auth',
-    ...
-]
-
-JWT_SECRET = "t0ps3cr3t"
-```
-
-Create a super-user:
-
-```
-ohmyapi createsuperuser
-```
-
-

ohmyapi-0.1.6.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-ohmyapi=ohmyapi.cli:main
-