faster-app 0.1.0__tar.gz

faster_app-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Cloud Truss Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

faster_app-0.1.0/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: faster-app
+Version: 0.1.0
+Summary: 一个轻量级的 Python Web 框架，提供自动发现、模型基类、命令行工具等功能
+Author-email: peizhenfei <peizhenfei@hotmail.com>
+Maintainer-email: peizhenfei <peizhenfei@hotmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/mautops/faster-app
+Project-URL: Documentation, https://github.com/mautops/faster-app#readme
+Project-URL: Repository, https://github.com/mautops/faster-app.git
+Project-URL: Bug Tracker, https://github.com/mautops/faster-app/issues
+Keywords: web,framework,fastapi,tortoise,orm,cli
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aerich>=0.9.1
+Requires-Dist: fastapi>=0.116.1
+Requires-Dist: fire>=0.7.1
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pydantic-settings>=2.10.1
+Requires-Dist: rich>=14.1.0
+Requires-Dist: tortoise-orm>=0.25.1
+Requires-Dist: uvicorn>=0.35.0
+Dynamic: license-file
+
+# Faster API
+
+[![Python](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.116.1+-green.svg)](https://fastapi.tiangolo.com/)
+[![Tortoise ORM](https://img.shields.io/badge/Tortoise%20ORM-0.25.1+-orange.svg)](https://tortoise.github.io/)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+一个轻量级、高性能的 Python Web 框架，基于 FastAPI 和 Tortoise ORM 构建，提供自动发现、模型基类、命令行工具等企业级功能。
+
+## ✨ 核心特性
+
+- 🔍 **智能自动发现**: 自动扫描和加载模块、模型、路由和命令
+- 🗄️ **丰富模型基类**: 基于 Tortoise ORM 的企业级模型基类
+- 🛠️ **强大命令行工具**: 基于 Fire 的异步命令行工具框架
+- 🌐 **统一路由管理**: FastAPI 路由的标准化返回格式
+- 📦 **即插即用**: 模块化设计，开箱即用
+- ⚡ **高性能**: 异步架构，支持高并发
+- 🔧 **开发友好**: 内置数据库迁移、开发服务器等工具
+
+## 🚀 快速安装
+
+```bash
+pip install faster-app
+```
+
+# 📖 快速开始
+
+## 1. 项目结构
+
+```
+your-project/
+├── apps/                    # 应用目录
+│   ├── auth/
+│   │   ├── models.py       # 模型定义
+│   │   ├── routes.py       # 路由定义
+│   │   └── commands.py     # 命令定义
+│   └── user/
+│       ├── models.py
+│       ├── routes.py
+│       └── commands.py
+├── config/
+└──── settings.py           # 配置文件
+└── main.py                 # 入口文件
+```
+
+### 2. 模型定义
+
+```python
+# models.py
+from faster_api.models import UUIDModel, DateTimeModel, StatusModel
+from tortoise import fields
+
+class User(UUIDModel, DateTimeModel, StatusModel):
+    """用户模型"""
+    name = fields.CharField(max_length=50, description="用户名")
+    email = fields.CharField(max_length=100, unique=True, description="邮箱")
+
+    class Meta:
+        table = "users"
+        table_description = "用户表"
+```
+
+### 3. 路由定义
+
+```python
+# routes.py
+from fastapi import APIRouter
+from faster_api.routes import ApiResponse
+
+router = APIRouter(prefix="/api/v1/users", tags=["用户管理"])
+
+@router.get("/", response_model=ApiResponse)
+async def get_users():
+    """获取用户列表"""
+    users = await User.all()
+    return ApiResponse(
+        message="获取用户列表成功",
+        data={"users": users, "total": len(users)}
+    )
+
+@router.post("/", response_model=ApiResponse)
+async def create_user(name: str, email: str):
+    """创建用户"""
+    user = await User.create(name=name, email=email)
+    return ApiResponse(
+        message="用户创建成功",
+        data={"user": user}
+    )
+```
+
+### 4. 命令定义
+
+```python
+# commands.py
+from faster_api.commands import CommandBase
+
+class UserCommand(CommandBase):
+    """用户管理命令"""
+
+    async def create_user(self, name: str, email: str):
+        """创建用户"""
+        user = await User.create(name=name, email=email)
+        print(f"✅ 用户创建成功: {user.name} ({user.email})")
+
+    async def list_users(self):
+        """列出所有用户"""
+        users = await User.all()
+        print(f"📋 共找到 {len(users)} 个用户:")
+        for user in users:
+            print(f"  - {user.name} ({user.email})")
+```
+
+### 5. 启动应用
+
+```python
+# main.py
+import fire
+from faster_api.commands.discover import CommandDiscover
+
+if __name__ == "__main__":
+    # 自动发现并注册所有命令
+    command_instances = CommandDiscover().discover()
+    commands = {}
+    for instance in command_instances:
+        command_name = instance.get_command_name()
+        commands[command_name] = instance
+
+    fire.Fire(commands)
+```
+
+# 🛠️ 内置工具
+
+### 1. 数据库管理
+
+```bash
+# 初始化数据库
+python main.py db init_db
+
+# 生成迁移文件
+python main.py db migrate
+
+# 执行迁移
+python main.py db upgrade
+
+# 回滚迁移
+python main.py db downgrade
+
+# 查看迁移历史
+python main.py db history
+
+# 清理开发环境
+python main.py db dev_clean
+```
+
+### 2. 开发服务器
+
+```bash
+# 启动开发服务器
+python main.py fastapi start
+
+# 指定主机和端口
+python main.py fastapi start --host=0.0.0.0 --port=8080
+```
+
+# ⚙️ 配置管理
+
+> 默认配置，可以通过
+
+```python
+from pydantic_settings import BaseSettings
+
+class Settings(BaseSettings):
+    # 基础配置
+    PROJECT_NAME: str = ""
+    VERSION: str = "1.0.0"
+    DEBUG: bool = True
+
+    # 服务器配置
+    HOST: str = "127.0.0.1"
+    PORT: int = 8000
+
+    # API 配置
+    API_V1_STR: str = "/api/v1"
+
+    # JWT 配置
+    SECRET_KEY: str = "your-secret-key"
+    ALGORITHM: str = "HS256"
+    ACCESS_TOKEN_EXPIRE_MINUTES: int = 30
+
+    # 数据库配置
+    DB_ENGINE: str = "tortoise.backends.asyncpg"
+    DB_HOST: str = "localhost"
+    DB_PORT: int = 5432
+    DB_USER: str = "postgres"
+    DB_PASSWORD: str = "password"
+    DB_DATABASE: str = "mydb"
+
+# 实例化配置
+configs = Settings()
+```
+
+### 环境变量支持
+
+创建 `.env` 文件：
+
+```env
+PROJECT_NAME=My API Project
+DEBUG=true
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=password
+DB_DATABASE=mydb
+SECRET_KEY=your-secret-key-here
+```
+
+## 🤝 贡献指南
+
+我们欢迎所有形式的贡献！
+
+### 如何贡献
+
+1. Fork 本仓库
+2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启 Pull Request
+
+### 报告问题
+
+如果您发现了 bug 或有功能建议，请在 [Issues](https://github.com/your-org/faster-app/issues) 中提交。
+
+## 📄 许可证
+
+本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
+
+## 🙏 致谢
+
+- [FastAPI](https://fastapi.tiangolo.com/) - 现代、快速的 Web 框架
+- [Tortoise ORM](https://tortoise.github.io/) - 异步 ORM 框架
+- [Fire](https://github.com/google/python-fire) - 命令行接口生成器
+- [Pydantic](https://pydantic-docs.helpmanual.io/) - 数据验证库
+- [Rich](https://rich.readthedocs.io/) - 终端美化库
+
+## 📈 更新日志
+
+### v0.1.0 (2024-01-01)
+
+- 🎉 初始版本发布
+- ✅ 提供基础的自动发现功能
+- ✅ 提供模型、命令、路由基类
+- ✅ 提供数据库连接管理
+- ✅ 内置数据库迁移工具
+- ✅ 内置 FastAPI 开发服务器
+
+---
+
+**作者**: peizhenfei (peizhenfei@hotmail.com)
+
+**项目主页**: [https://github.com/mautops/faster-app.git](https://github.com/mautops/faster-app.git)

faster_app-0.1.0/README.md

@@ -0,0 +1,260 @@
+# Faster API
+
+[![Python](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.116.1+-green.svg)](https://fastapi.tiangolo.com/)
+[![Tortoise ORM](https://img.shields.io/badge/Tortoise%20ORM-0.25.1+-orange.svg)](https://tortoise.github.io/)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+一个轻量级、高性能的 Python Web 框架，基于 FastAPI 和 Tortoise ORM 构建，提供自动发现、模型基类、命令行工具等企业级功能。
+
+## ✨ 核心特性
+
+- 🔍 **智能自动发现**: 自动扫描和加载模块、模型、路由和命令
+- 🗄️ **丰富模型基类**: 基于 Tortoise ORM 的企业级模型基类
+- 🛠️ **强大命令行工具**: 基于 Fire 的异步命令行工具框架
+- 🌐 **统一路由管理**: FastAPI 路由的标准化返回格式
+- 📦 **即插即用**: 模块化设计，开箱即用
+- ⚡ **高性能**: 异步架构，支持高并发
+- 🔧 **开发友好**: 内置数据库迁移、开发服务器等工具
+
+## 🚀 快速安装
+
+```bash
+pip install faster-app
+```
+
+# 📖 快速开始
+
+## 1. 项目结构
+
+```
+your-project/
+├── apps/                    # 应用目录
+│   ├── auth/
+│   │   ├── models.py       # 模型定义
+│   │   ├── routes.py       # 路由定义
+│   │   └── commands.py     # 命令定义
+│   └── user/
+│       ├── models.py
+│       ├── routes.py
+│       └── commands.py
+├── config/
+└──── settings.py           # 配置文件
+└── main.py                 # 入口文件
+```
+
+### 2. 模型定义
+
+```python
+# models.py
+from faster_api.models import UUIDModel, DateTimeModel, StatusModel
+from tortoise import fields
+
+class User(UUIDModel, DateTimeModel, StatusModel):
+    """用户模型"""
+    name = fields.CharField(max_length=50, description="用户名")
+    email = fields.CharField(max_length=100, unique=True, description="邮箱")
+
+    class Meta:
+        table = "users"
+        table_description = "用户表"
+```
+
+### 3. 路由定义
+
+```python
+# routes.py
+from fastapi import APIRouter
+from faster_api.routes import ApiResponse
+
+router = APIRouter(prefix="/api/v1/users", tags=["用户管理"])
+
+@router.get("/", response_model=ApiResponse)
+async def get_users():
+    """获取用户列表"""
+    users = await User.all()
+    return ApiResponse(
+        message="获取用户列表成功",
+        data={"users": users, "total": len(users)}
+    )
+
+@router.post("/", response_model=ApiResponse)
+async def create_user(name: str, email: str):
+    """创建用户"""
+    user = await User.create(name=name, email=email)
+    return ApiResponse(
+        message="用户创建成功",
+        data={"user": user}
+    )
+```
+
+### 4. 命令定义
+
+```python
+# commands.py
+from faster_api.commands import CommandBase
+
+class UserCommand(CommandBase):
+    """用户管理命令"""
+
+    async def create_user(self, name: str, email: str):
+        """创建用户"""
+        user = await User.create(name=name, email=email)
+        print(f"✅ 用户创建成功: {user.name} ({user.email})")
+
+    async def list_users(self):
+        """列出所有用户"""
+        users = await User.all()
+        print(f"📋 共找到 {len(users)} 个用户:")
+        for user in users:
+            print(f"  - {user.name} ({user.email})")
+```
+
+### 5. 启动应用
+
+```python
+# main.py
+import fire
+from faster_api.commands.discover import CommandDiscover
+
+if __name__ == "__main__":
+    # 自动发现并注册所有命令
+    command_instances = CommandDiscover().discover()
+    commands = {}
+    for instance in command_instances:
+        command_name = instance.get_command_name()
+        commands[command_name] = instance
+
+    fire.Fire(commands)
+```
+
+# 🛠️ 内置工具
+
+### 1. 数据库管理
+
+```bash
+# 初始化数据库
+python main.py db init_db
+
+# 生成迁移文件
+python main.py db migrate
+
+# 执行迁移
+python main.py db upgrade
+
+# 回滚迁移
+python main.py db downgrade
+
+# 查看迁移历史
+python main.py db history
+
+# 清理开发环境
+python main.py db dev_clean
+```
+
+### 2. 开发服务器
+
+```bash
+# 启动开发服务器
+python main.py fastapi start
+
+# 指定主机和端口
+python main.py fastapi start --host=0.0.0.0 --port=8080
+```
+
+# ⚙️ 配置管理
+
+> 默认配置，可以通过
+
+```python
+from pydantic_settings import BaseSettings
+
+class Settings(BaseSettings):
+    # 基础配置
+    PROJECT_NAME: str = ""
+    VERSION: str = "1.0.0"
+    DEBUG: bool = True
+
+    # 服务器配置
+    HOST: str = "127.0.0.1"
+    PORT: int = 8000
+
+    # API 配置
+    API_V1_STR: str = "/api/v1"
+
+    # JWT 配置
+    SECRET_KEY: str = "your-secret-key"
+    ALGORITHM: str = "HS256"
+    ACCESS_TOKEN_EXPIRE_MINUTES: int = 30
+
+    # 数据库配置
+    DB_ENGINE: str = "tortoise.backends.asyncpg"
+    DB_HOST: str = "localhost"
+    DB_PORT: int = 5432
+    DB_USER: str = "postgres"
+    DB_PASSWORD: str = "password"
+    DB_DATABASE: str = "mydb"
+
+# 实例化配置
+configs = Settings()
+```
+
+### 环境变量支持
+
+创建 `.env` 文件：
+
+```env
+PROJECT_NAME=My API Project
+DEBUG=true
+DB_HOST=localhost
+DB_PORT=5432
+DB_USER=postgres
+DB_PASSWORD=password
+DB_DATABASE=mydb
+SECRET_KEY=your-secret-key-here
+```
+
+## 🤝 贡献指南
+
+我们欢迎所有形式的贡献！
+
+### 如何贡献
+
+1. Fork 本仓库
+2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启 Pull Request
+
+### 报告问题
+
+如果您发现了 bug 或有功能建议，请在 [Issues](https://github.com/your-org/faster-app/issues) 中提交。
+
+## 📄 许可证
+
+本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
+
+## 🙏 致谢
+
+- [FastAPI](https://fastapi.tiangolo.com/) - 现代、快速的 Web 框架
+- [Tortoise ORM](https://tortoise.github.io/) - 异步 ORM 框架
+- [Fire](https://github.com/google/python-fire) - 命令行接口生成器
+- [Pydantic](https://pydantic-docs.helpmanual.io/) - 数据验证库
+- [Rich](https://rich.readthedocs.io/) - 终端美化库
+
+## 📈 更新日志
+
+### v0.1.0 (2024-01-01)
+
+- 🎉 初始版本发布
+- ✅ 提供基础的自动发现功能
+- ✅ 提供模型、命令、路由基类
+- ✅ 提供数据库连接管理
+- ✅ 内置数据库迁移工具
+- ✅ 内置 FastAPI 开发服务器
+
+---
+
+**作者**: peizhenfei (peizhenfei@hotmail.com)
+
+**项目主页**: [https://github.com/mautops/faster-app.git](https://github.com/mautops/faster-app.git)

faster_app-0.1.0/faster_api/__init__.py

@@ -0,0 +1,58 @@
+"""
+Faster API - 一个轻量级的 Python Web 框架
+
+提供了以下核心功能：
+- 自动发现和加载模块 (DiscoverBase)
+- 数据库模型基类 (UUIDModel, DateTimeModel, StatusModel, ScopeModel)
+- 命令行工具基类 (CommandBase)
+- 路由管理 (ApiResponse)
+- 数据库连接管理 (tortoise_init)
+"""
+
+__version__ = "0.1.0"
+__author__ = "peizhenfei"
+__email__ = "peizhenfei@hotmail.com"
+
+# 导出主要的类和函数
+from faster_api.base import DiscoverBase
+from faster_api.models.base import (
+    UUIDModel,
+    DateTimeModel,
+    StatusModel,
+    ScopeModel,
+    SyncTimeModel,
+    SyncCrontabModel,
+)
+from faster_api.commands.base import CommandBase, with_db_init
+from faster_api.routes.base import ApiResponse
+from faster_api.db import tortoise_init
+
+# 导出发现器
+from faster_api.models.discover import ModelDiscover
+from faster_api.commands.discover import CommandDiscover
+from faster_api.routes.discover import RoutesDiscover
+
+# 导出配置
+from faster_api.settings.builtins.settings import DefaultSettings
+
+__all__ = [
+    # 基础类
+    "DiscoverBase",
+    "CommandBase",
+    "with_db_init",
+    "ApiResponse",
+    "tortoise_init",
+    # 模型基类
+    "UUIDModel",
+    "DateTimeModel",
+    "StatusModel",
+    "ScopeModel",
+    "SyncTimeModel",
+    "SyncCrontabModel",
+    # 发现器
+    "ModelDiscover",
+    "CommandDiscover",
+    "RoutesDiscover",
+    # 配置
+    "DefaultSettings",
+]