Metadata-Version: 2.2
Name: fastapi-core-utils
Version: 0.0.3
Summary: FastAPI utilities for rapid development
Author-email: 刘浩 <jiumengs@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/yourusername/fastapi-core-utils
Project-URL: Documentation, https://github.com/yourusername/fastapi-core-utils#readme
Project-URL: Repository, https://github.com/yourusername/fastapi-core-utils.git
Keywords: fastapi,utils,database,router
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi>=0.68.0
Requires-Dist: tortoise-orm>=0.17.0
Requires-Dist: pyyaml>=5.4.1

# FastAPI Utils

FastAPI utilities for rapid development.

## Features

- Database Management
  - Easy database initialization
  - Entity base class with common fields
  - YAML/JSON configuration support

- Router Management
  - Decorator-based routing
  - Auto-scanning controllers
  - Easy route grouping

## Installation

```bash
pip install fastapi-core-utils
```

## Quick Start

```python
from fastapi import FastAPI
from fastapi_core_utils.router import RouterManager, controller, route
from fastapi_core_utils.database import DBManager

app = FastAPI()

# Initialize database
await DBManager.init_db(
  app=app,
  config="config/database.yaml",
  entity_dir="fastapi_core_utils/entity"
)


# Define controller
@controller(prefix="/api", tags=["example"])
class ExampleController:
  @route.get("/hello")
  async def hello(self):
    return {"message": "Hello World"}


# Auto include controllers
RouterManager.auto_include_routers(
  app=app,
  controllers_dir="app/src/controllers"
)
```

## Documentation

For more details, please visit our [GitHub repository](https://github.com/yourusername/fastapi-core-utils).

## License

This project is licensed under the MIT License. 
