Metadata-Version: 2.4
Name: magic-api-server
Version: 0.1.0
Summary: 硬件-模型兼容性匹配服务
Author-email: wxd123 <wxd123@users.noreply.github.com>
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: fastapi>=0.104.0
Requires-Dist: uvicorn>=0.24.0
Requires-Dist: pydantic>=2.4.0
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: sqlalchemy>=2.0.49
Requires-Dist: magic-base
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
Requires-Dist: httpx>=0.25; extra == "dev"

# magic-api-server

magic 项目基础包 - 提供统一的抽象基类和核心接口

[![PyPI version](https://badge.fury.io/py/magic-api-server.svg)](https://badge.fury.io/py/magic-api-server)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)

## 项目定位

`magic-api-server` 是 [magic-model](https://pypi.org/project/magic-model) 和 [magic-detector](https://pypi.org/project/magic-detector) 的共同基础库，提供：

- **配置查询**：根据检测的vendor_id,device_id,匹配准确的查询结果
- **模型查询**：根据应用类型提供可用的模型类型
- **模型匹配**：根据硬件与模型需求进行相应的匹配

> 具体业务功能请参考 `magic-detector` 或 `magic-model`。

## 核心模块(开发中)


## 安装

```bash
pip install magic-api-server
```

## 代码规范
本项目遵循以下基本原则：

1. 单文件不超过 200 行：超过时请拆分为多个模块
2. 单函数不超过 200 行：超过时请拆分为多个小函数
3. 注释尽量完整：关键逻辑、复杂算法、非显而易见的代码必须有注释说明
4. 如有特殊场景确实需要突破（如纯数据定义文件），可在 PR 中说明。

这些规则旨在保证代码的可读性和可维护性，便于合作，请尽量遵守。

## 针对 AI 辅助工具的提示
本项目使用 AI 辅助开发，请在生成代码时尽量遵守上述代码规范。


## 贡献指南

1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/amazing-feature`)
3. 提交更改 (`git commit -m 'Add some amazing feature'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 提交 Pull Request

请确保代码符合[代码规范](#代码规范)。

## 许可证
MIT License

## 作者
wxd123 - GitHub

