# CRUD Tortoise ORM Extension
## Project Overview
This project is an extension that implements CRUD operations based on Tortoise ORM, providing a simple and efficient way to manage database records.
## Installation Instructions
Install the `wh-fastapi-crud-tortoise` package:
```bash
pip install wh-fastapi-crud-tortoise
```
## Usage
Here is a basic example of how to use the CRUD extension:
```python
from fastapi import FastAPI
from pydantic import BaseModel, ConfigDict
from datetime import datetime, date
from typing import Optional, Union
from datetime import datetime
from tortoise import fields
from src import CrudModel, TortoiseCRUDRouter, resp_success, resp_fail
from tortoise.contrib.fastapi import register_tortoise
class DummyModel(CrudModel):
"""Record Table"""
name = fields.CharField(max_length=255, null=False)
age = fields.IntField()
salary = fields.FloatField()
is_active = fields.BooleanField(default=True)
birthdate = fields.DateField()
created_at = fields.DatetimeField()
notes = fields.TextField()
json_data = fields.JSONField(null=True, default=None)
class Meta:
table = "dummy"
ID_TYPE = str
class DummyCreateDTO(BaseModel):
name: str
age: int
salary: float
is_active: bool
birthdate: date
created_at: datetime
notes: str
json_data: Optional[object] = None
class DummyDTO(BaseModel):
id: Optional[ID_TYPE] = None
name: Optional[str] = None
age: Optional[int] = None
salary: Optional[float] = None
is_active: Optional[bool] = None
birthdate: Optional[date] = None
created_at: Optional[datetime] = None
notes: Optional[str] = None
json_data: Optional[object] = None
model_config = ConfigDict(from_attributes=True)
dummy_router = TortoiseCRUDRouter(
schema=DummyDTO, create_schema=DummyCreateDTO, db_model=DummyModel, prefix="dummy"
)
@dummy_router.post("/custom_router")
async def test(para1: int, para2: str):
return resp_success(data="test custom router")
app = FastAPI(title="FastapiCrudPro")
register_tortoise(
app,
db_url="sqlite://tortoise.sqlite3",
modules={"models": ["demo"]},
generate_schemas=True,
add_exception_handlers=True,
)
app.include_router(dummy_router)
@app.get("/")
def read_root():
return {"Hello": "World"}
if __name__ == "__main__":
import uvicorn
uvicorn.run(app="demo:app", host="127.0.0.1", port=8010, reload=True)
```
## API Documentation
To view the API documentation, open your browser and navigate to `http://127.0.0.1:8010/docs`.
<img alt="dummy" src="https://raw.githubusercontent.com/kanbang/fastapi-crud-pro/master/doc/dummy.png">
## License
This project is licensed under the MIT License.
Raw data
{
"_id": null,
"home_page": "https://github.com/kanbang/fastapi-crud-pro",
"name": "wh-fastapi-crud-tortoise",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "crud, tortoise-orm, sqlalchemy, database",
"author": "kanbang",
"author_email": "kanbang@163.com",
"download_url": null,
"platform": null,
"description": "# CRUD Tortoise ORM Extension\r\n\r\n## Project Overview\r\nThis project is an extension that implements CRUD operations based on Tortoise ORM, providing a simple and efficient way to manage database records.\r\n\r\n## Installation Instructions\r\n\r\nInstall the `wh-fastapi-crud-tortoise` package:\r\n ```bash\r\n pip install wh-fastapi-crud-tortoise\r\n ```\r\n\r\n## Usage\r\nHere is a basic example of how to use the CRUD extension:\r\n\r\n```python\r\nfrom fastapi import FastAPI\r\nfrom pydantic import BaseModel, ConfigDict\r\nfrom datetime import datetime, date\r\nfrom typing import Optional, Union\r\n\r\nfrom datetime import datetime\r\nfrom tortoise import fields\r\nfrom src import CrudModel, TortoiseCRUDRouter, resp_success, resp_fail\r\nfrom tortoise.contrib.fastapi import register_tortoise\r\n\r\n\r\nclass DummyModel(CrudModel):\r\n \"\"\"Record Table\"\"\"\r\n\r\n name = fields.CharField(max_length=255, null=False)\r\n age = fields.IntField()\r\n salary = fields.FloatField()\r\n is_active = fields.BooleanField(default=True)\r\n birthdate = fields.DateField()\r\n created_at = fields.DatetimeField()\r\n notes = fields.TextField()\r\n json_data = fields.JSONField(null=True, default=None)\r\n\r\n class Meta:\r\n table = \"dummy\"\r\n\r\n\r\nID_TYPE = str\r\n\r\n\r\nclass DummyCreateDTO(BaseModel):\r\n name: str\r\n age: int\r\n salary: float\r\n is_active: bool\r\n birthdate: date\r\n created_at: datetime\r\n notes: str\r\n json_data: Optional[object] = None\r\n\r\n\r\nclass DummyDTO(BaseModel):\r\n id: Optional[ID_TYPE] = None\r\n name: Optional[str] = None\r\n age: Optional[int] = None\r\n salary: Optional[float] = None\r\n is_active: Optional[bool] = None\r\n birthdate: Optional[date] = None\r\n created_at: Optional[datetime] = None\r\n notes: Optional[str] = None\r\n json_data: Optional[object] = None\r\n\r\n model_config = ConfigDict(from_attributes=True)\r\n\r\n\r\ndummy_router = TortoiseCRUDRouter(\r\n schema=DummyDTO, create_schema=DummyCreateDTO, db_model=DummyModel, prefix=\"dummy\"\r\n)\r\n\r\n\r\n@dummy_router.post(\"/custom_router\")\r\nasync def test(para1: int, para2: str):\r\n return resp_success(data=\"test custom router\")\r\n\r\n\r\napp = FastAPI(title=\"FastapiCrudPro\")\r\nregister_tortoise(\r\n app,\r\n db_url=\"sqlite://tortoise.sqlite3\",\r\n modules={\"models\": [\"demo\"]},\r\n generate_schemas=True,\r\n add_exception_handlers=True,\r\n)\r\n\r\napp.include_router(dummy_router)\r\n\r\n\r\n@app.get(\"/\")\r\ndef read_root():\r\n return {\"Hello\": \"World\"}\r\n\r\n\r\nif __name__ == \"__main__\":\r\n import uvicorn\r\n\r\n uvicorn.run(app=\"demo:app\", host=\"127.0.0.1\", port=8010, reload=True)\r\n```\r\n\r\n## API Documentation\r\nTo view the API documentation, open your browser and navigate to `http://127.0.0.1:8010/docs`.\r\n\r\n<img alt=\"dummy\" src=\"https://raw.githubusercontent.com/kanbang/fastapi-crud-pro/master/doc/dummy.png\">\r\n\r\n## License\r\nThis project is licensed under the MIT License.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A CRUD library for Tortoise ORM",
"version": "0.1.9",
"project_urls": {
"Bug Reports": "https://github.com/kanbang/fastapi-crud-pro/issues",
"Homepage": "https://github.com/kanbang/fastapi-crud-pro",
"Source": "https://github.com/kanbang/fastapi-crud-pro"
},
"split_keywords": [
"crud",
" tortoise-orm",
" sqlalchemy",
" database"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f45d9a714e2612c451b0a96a106a751bdf2a5ebb3dbda41c06795c908c57e9e0",
"md5": "48b76a6f7dee50d40437b9490fb53aab",
"sha256": "701bb69328fff39271e3a02754c43bdeb69f22469f958f4ad3a6294fb111cf7c"
},
"downloads": -1,
"filename": "wh_fastapi_crud_tortoise-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48b76a6f7dee50d40437b9490fb53aab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 35015,
"upload_time": "2025-02-25T10:42:05",
"upload_time_iso_8601": "2025-02-25T10:42:05.298201Z",
"url": "https://files.pythonhosted.org/packages/f4/5d/9a714e2612c451b0a96a106a751bdf2a5ebb3dbda41c06795c908c57e9e0/wh_fastapi_crud_tortoise-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-25 10:42:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kanbang",
"github_project": "fastapi-crud-pro",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wh-fastapi-crud-tortoise"
}
JSON
