ohmyapi 0.1.0__tar.gz → 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/PKG-INFO +17 -2
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/README.md +16 -1
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/pyproject.toml +1 -1
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/builtin/auth/models.py +8 -1
- ohmyapi-0.1.1/src/ohmyapi/db/model/model.py +46 -0
- ohmyapi-0.1.0/src/ohmyapi/db/model/model.py +0 -80
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/__init__.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/builtin/auth/__init__.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/builtin/auth/permissions.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/builtin/auth/routes.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/cli.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/core/__init__.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/core/runtime.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/core/scaffolding.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/core/templates/app/__init__.py.j2 +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/core/templates/app/models.py.j2 +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/core/templates/app/routes.py.j2 +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/core/templates/project/pyproject.toml.j2 +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/core/templates/project/settings.py.j2 +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/db/__init__.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/db/migration_manager.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/db/model/__init__.py +0 -0
- {ohmyapi-0.1.0 → ohmyapi-0.1.1}/src/ohmyapi/router.py +0 -0
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.4
|
2
2
|
Name: ohmyapi
|
3
|
-
Version: 0.1.
|
3
|
+
Version: 0.1.1
|
4
4
|
Summary: A Django-like but async web-framework based on FastAPI and TortoiseORM.
|
5
5
|
License-Expression: MIT
|
6
6
|
Keywords: fastapi,tortoise,orm,async,web-framework
|
@@ -142,7 +142,21 @@ Similar to Django, first run:
|
|
142
142
|
ohmyapi makemigrations [ <app> ] # no app means all INSTALLED_APPS
|
143
143
|
```
|
144
144
|
|
145
|
-
|
145
|
+
This will create a `migrations/` folder in you project root.
|
146
|
+
|
147
|
+
```
|
148
|
+
myproject/
|
149
|
+
- myapp/
|
150
|
+
- __init__.py
|
151
|
+
- models.py
|
152
|
+
- routes.py
|
153
|
+
- migrations/
|
154
|
+
- myapp/
|
155
|
+
- pyproject.toml
|
156
|
+
- settings.py
|
157
|
+
```
|
158
|
+
|
159
|
+
Apply your migrations via:
|
146
160
|
|
147
161
|
```
|
148
162
|
ohmyapi migrate [ <app> ] # no app means all INSTALLED_APPS
|
@@ -165,6 +179,7 @@ ohmyapi shell
|
|
165
179
|
## Authentication
|
166
180
|
|
167
181
|
A builtin auth app is available.
|
182
|
+
|
168
183
|
Simply add `ohmyapi_auth` to your INSTALLED_APPS and define a JWT_SECRET in your `settings.py`.
|
169
184
|
Remember to `makemigrations` and `migrate` for the auth tables to be created in the database.
|
170
185
|
|
@@ -116,7 +116,21 @@ Similar to Django, first run:
|
|
116
116
|
ohmyapi makemigrations [ <app> ] # no app means all INSTALLED_APPS
|
117
117
|
```
|
118
118
|
|
119
|
-
|
119
|
+
This will create a `migrations/` folder in you project root.
|
120
|
+
|
121
|
+
```
|
122
|
+
myproject/
|
123
|
+
- myapp/
|
124
|
+
- __init__.py
|
125
|
+
- models.py
|
126
|
+
- routes.py
|
127
|
+
- migrations/
|
128
|
+
- myapp/
|
129
|
+
- pyproject.toml
|
130
|
+
- settings.py
|
131
|
+
```
|
132
|
+
|
133
|
+
Apply your migrations via:
|
120
134
|
|
121
135
|
```
|
122
136
|
ohmyapi migrate [ <app> ] # no app means all INSTALLED_APPS
|
@@ -139,6 +153,7 @@ ohmyapi shell
|
|
139
153
|
## Authentication
|
140
154
|
|
141
155
|
A builtin auth app is available.
|
156
|
+
|
142
157
|
Simply add `ohmyapi_auth` to your INSTALLED_APPS and define a JWT_SECRET in your `settings.py`.
|
143
158
|
Remember to `makemigrations` and `migrate` for the auth tables to be created in the database.
|
144
159
|
|
@@ -1,23 +1,30 @@
|
|
1
1
|
from typing import Optional, List
|
2
2
|
from ohmyapi.db import Model, field
|
3
3
|
from passlib.context import CryptContext
|
4
|
+
from tortoise.contrib.pydantic import pydantic_queryset_creator
|
4
5
|
|
5
6
|
pwd_context = CryptContext(schemes=["argon2"], deprecated="auto")
|
6
7
|
|
7
8
|
|
8
9
|
class Group(Model):
|
9
10
|
id = field.IntField(pk=True)
|
10
|
-
name = field.CharField(max_length=42)
|
11
|
+
name = field.CharField(max_length=42, index=True)
|
11
12
|
|
12
13
|
|
13
14
|
class User(Model):
|
14
15
|
id = field.IntField(pk=True)
|
16
|
+
email = CharField(unique=True, index=True)
|
15
17
|
username = field.CharField(max_length=150, unique=True)
|
16
18
|
password_hash = field.CharField(max_length=128)
|
17
19
|
is_admin = field.BooleanField(default=False)
|
18
20
|
is_staff = field.BooleanField(default=False)
|
19
21
|
groups: Optional[List[Group]] = field.ManyToManyField("ohmyapi_auth.Group", related_name="users")
|
20
22
|
|
23
|
+
|
24
|
+
class Schema:
|
25
|
+
exclude = 'password_hash',
|
26
|
+
|
27
|
+
|
21
28
|
def set_password(self, raw_password: str) -> None:
|
22
29
|
"""Hash and store the password."""
|
23
30
|
self.password_hash = pwd_context.hash(raw_password)
|
@@ -0,0 +1,46 @@
|
|
1
|
+
from tortoise import fields
|
2
|
+
from tortoise.models import Model as TortoiseModel
|
3
|
+
from tortoise.contrib.pydantic import pydantic_model_creator, pydantic_queryset_creator
|
4
|
+
|
5
|
+
|
6
|
+
class ModelMeta(type(TortoiseModel)):
|
7
|
+
def __new__(cls, name, bases, attrs):
|
8
|
+
new_cls = super().__new__(cls, name, bases, attrs)
|
9
|
+
|
10
|
+
schema_opts = getattr(new_cls, "Schema", None)
|
11
|
+
|
12
|
+
class BoundSchema:
|
13
|
+
@property
|
14
|
+
def one(self):
|
15
|
+
"""Return a Pydantic model class for 'one' results."""
|
16
|
+
include = getattr(schema_opts, "include", None)
|
17
|
+
exclude = getattr(schema_opts, "exclude", None)
|
18
|
+
return pydantic_model_creator(
|
19
|
+
new_cls,
|
20
|
+
name=f"{new_cls.__name__}SchemaOne",
|
21
|
+
include=include,
|
22
|
+
exclude=exclude,
|
23
|
+
exclude_readonly=True,
|
24
|
+
)
|
25
|
+
|
26
|
+
@property
|
27
|
+
def many(self):
|
28
|
+
"""Return a Pydantic queryset class for 'many' results."""
|
29
|
+
include = getattr(schema_opts, "include", None)
|
30
|
+
exclude = getattr(schema_opts, "exclude", None)
|
31
|
+
return pydantic_queryset_creator(
|
32
|
+
new_cls,
|
33
|
+
name=f"{new_cls.__name__}SchemaMany",
|
34
|
+
include=include,
|
35
|
+
exclude=exclude,
|
36
|
+
)
|
37
|
+
|
38
|
+
new_cls.Schema = BoundSchema()
|
39
|
+
return new_cls
|
40
|
+
|
41
|
+
|
42
|
+
class Model(TortoiseModel, metaclass=ModelMeta):
|
43
|
+
class Schema:
|
44
|
+
include = None
|
45
|
+
exclude = None
|
46
|
+
|
@@ -1,80 +0,0 @@
|
|
1
|
-
from tortoise import fields
|
2
|
-
from tortoise.models import Model as TortoiseModel
|
3
|
-
from tortoise.contrib.pydantic import pydantic_model_creator, pydantic_queryset_creator
|
4
|
-
|
5
|
-
|
6
|
-
class Model(TortoiseModel):
|
7
|
-
"""
|
8
|
-
Base Tortoise model with attached Pydantic schema generators via .Schema
|
9
|
-
"""
|
10
|
-
|
11
|
-
class Schema:
|
12
|
-
"""
|
13
|
-
Provides convenient access to auto-generated Pydantic schemas.
|
14
|
-
"""
|
15
|
-
|
16
|
-
def __init__(self, model_cls):
|
17
|
-
self.model_cls = model_cls
|
18
|
-
|
19
|
-
@property
|
20
|
-
def id(self):
|
21
|
-
# Minimal schema with just the primary key field
|
22
|
-
pk_field = self.model_cls._meta.pk_attr
|
23
|
-
return pydantic_model_creator(
|
24
|
-
self.model_cls, name=f"{self.model_cls.__name__}SchemaId", include=(pk_field,)
|
25
|
-
)
|
26
|
-
|
27
|
-
@property
|
28
|
-
def get(self):
|
29
|
-
# Full schema for reading
|
30
|
-
return pydantic_model_creator(
|
31
|
-
self.model_cls, name=f"{self.model_cls.__name__}SchemaGet"
|
32
|
-
)
|
33
|
-
|
34
|
-
@property
|
35
|
-
def post(self):
|
36
|
-
# Input schema for creation (no readonly fields like ID/PK)
|
37
|
-
return pydantic_model_creator(
|
38
|
-
self.model_cls,
|
39
|
-
name=f"{self.model_cls.__name__}SchemaPost",
|
40
|
-
exclude_readonly=True,
|
41
|
-
)
|
42
|
-
|
43
|
-
@property
|
44
|
-
def put(self):
|
45
|
-
# Input schema for updating
|
46
|
-
return pydantic_model_creator(
|
47
|
-
self.model_cls,
|
48
|
-
name=f"{self.model_cls.__name__}SchemaPut",
|
49
|
-
exclude_readonly=True,
|
50
|
-
)
|
51
|
-
|
52
|
-
@property
|
53
|
-
def delete(self):
|
54
|
-
# Schema for delete operations (just PK)
|
55
|
-
pk_field = self.model_cls._meta.pk_attr
|
56
|
-
return pydantic_model_creator(
|
57
|
-
self.model_cls, name=f"{self.model_cls.__name__}SchemaDelete", include=(pk_field,)
|
58
|
-
)
|
59
|
-
|
60
|
-
@property
|
61
|
-
def list(self):
|
62
|
-
# Schema for list endpoints
|
63
|
-
return pydantic_queryset_creator(self.model_cls)
|
64
|
-
|
65
|
-
def from_fields(self, *fields: str):
|
66
|
-
# Generate schema restricted to given fields
|
67
|
-
valid = [f for f in fields if f in self.model_cls._meta.fields_map]
|
68
|
-
return pydantic_model_creator(
|
69
|
-
self.model_cls,
|
70
|
-
name=f"{self.model_cls.__name__}SchemaFields",
|
71
|
-
include=valid,
|
72
|
-
)
|
73
|
-
|
74
|
-
def __init_subclass__(cls, **kwargs):
|
75
|
-
"""
|
76
|
-
Automatically attach .Schema to all subclasses
|
77
|
-
"""
|
78
|
-
super().__init_subclass__(**kwargs)
|
79
|
-
cls.Schema = cls.Schema(cls)
|
80
|
-
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|