# xiaoapi
基于FastAPI封装的快速开发框架
## 安装xiaoapi
```
pip install xiaoapi
```
## 创建项目
创建项目目录及项目文件
`python -m xiaoapi.admin create-project --name project_name`
如果项目路径已存在，并且在项目路径下，可直接使用以下命令创建项目文件
`python -m xiaoapi.admin create-project-files`
创建项目后，会新增一下目录结构：
```
.
├── application
│ ├── __init__.py
│ ├── routes.py # 主路由配置文件
│ ├── settings.py # 项目配置文件
└── manage.py # 命令管理器，使用"python manage.py --help"查看全部命令
```
## 启动服务
```
python manage.py run-server
```
## demo演示
- https://github.com/xiaojinlii/xiaoapi-demo
Raw data
{
"_id": null,
"home_page": null,
"name": "xiaoapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "xiaoapi, fastapi, web-framework",
"author": null,
"author_email": "xiaojinli <553555614@qq.com>",
"download_url": "https://files.pythonhosted.org/packages/65/b2/907efe91a2ed8c375c2b394fc43db81a4c0b5223923a778d02bf887e36b5/xiaoapi-0.0.3.tar.gz",
"platform": null,
"description": "# xiaoapi\r\n\u57fa\u4e8eFastAPI\u5c01\u88c5\u7684\u5feb\u901f\u5f00\u53d1\u6846\u67b6\r\n\r\n\r\n## \u5b89\u88c5xiaoapi\r\n```\r\npip install xiaoapi\r\n```\r\n\r\n\r\n## \u521b\u5efa\u9879\u76ee\r\n\u521b\u5efa\u9879\u76ee\u76ee\u5f55\u53ca\u9879\u76ee\u6587\u4ef6\r\n`python -m xiaoapi.admin create-project --name project_name`\r\n\r\n\u5982\u679c\u9879\u76ee\u8def\u5f84\u5df2\u5b58\u5728\uff0c\u5e76\u4e14\u5728\u9879\u76ee\u8def\u5f84\u4e0b\uff0c\u53ef\u76f4\u63a5\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u521b\u5efa\u9879\u76ee\u6587\u4ef6\r\n`python -m xiaoapi.admin create-project-files`\r\n\r\n\u521b\u5efa\u9879\u76ee\u540e\uff0c\u4f1a\u65b0\u589e\u4e00\u4e0b\u76ee\u5f55\u7ed3\u6784\uff1a\r\n```\r\n.\r\n\u251c\u2500\u2500 application\r\n\u2502 \u251c\u2500\u2500 __init__.py\r\n\u2502 \u251c\u2500\u2500 routes.py # \u4e3b\u8def\u7531\u914d\u7f6e\u6587\u4ef6\r\n\u2502 \u251c\u2500\u2500 settings.py # \u9879\u76ee\u914d\u7f6e\u6587\u4ef6\r\n\u2514\u2500\u2500 manage.py # \u547d\u4ee4\u7ba1\u7406\u5668\uff0c\u4f7f\u7528\"python manage.py --help\"\u67e5\u770b\u5168\u90e8\u547d\u4ee4\r\n```\r\n\r\n\r\n## \u542f\u52a8\u670d\u52a1\r\n```\r\npython manage.py run-server\r\n```\r\n\r\n\r\n## demo\u6f14\u793a\r\n- https://github.com/xiaojinlii/xiaoapi-demo\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A fastapi framework for web development",
"version": "0.0.3",
"project_urls": {
"Documentation": "https://github.com/xiaojinlii/xiaoapi/blob/main/README.md",
"Source": "https://github.com/xiaojinlii/xiaoapi"
},
"split_keywords": [
"xiaoapi",
" fastapi",
" web-framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8cb7c1559bea5e14be59853f030401b1aabab4f7febe99eb6f2e2f1be83e6bc1",
"md5": "f18e4b6d02467f6b6d488bd16f9a8f2a",
"sha256": "223ed9819d68efa06c853e013293c1a6a914ed56197fd996da4499d7c7bcccd9"
},
"downloads": -1,
"filename": "xiaoapi-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f18e4b6d02467f6b6d488bd16f9a8f2a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1162176,
"upload_time": "2024-03-29T02:03:29",
"upload_time_iso_8601": "2024-03-29T02:03:29.567741Z",
"url": "https://files.pythonhosted.org/packages/8c/b7/c1559bea5e14be59853f030401b1aabab4f7febe99eb6f2e2f1be83e6bc1/xiaoapi-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "65b2907efe91a2ed8c375c2b394fc43db81a4c0b5223923a778d02bf887e36b5",
"md5": "8176a21e32c4106868bb6514d6fa8eee",
"sha256": "cf0e671eda9639b5b39650fbb68cc4833501e8d48696cf6d25d29f0a9d601055"
},
"downloads": -1,
"filename": "xiaoapi-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "8176a21e32c4106868bb6514d6fa8eee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1165604,
"upload_time": "2024-03-29T02:03:32",
"upload_time_iso_8601": "2024-03-29T02:03:32.423118Z",
"url": "https://files.pythonhosted.org/packages/65/b2/907efe91a2ed8c375c2b394fc43db81a4c0b5223923a778d02bf887e36b5/xiaoapi-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 02:03:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xiaojinlii",
"github_project": "xiaoapi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "fastapi",
"specs": [
[
"==",
"0.110.0"
]
]
},
{
"name": "uvicorn",
"specs": [
[
"==",
"0.25.0"
]
]
},
{
"name": "typer",
"specs": [
[
"==",
"0.10.0"
]
]
},
{
"name": "loguru",
"specs": [
[
"==",
"0.7.2"
]
]
},
{
"name": "orjson",
"specs": [
[
"==",
"3.9.15"
]
]
},
{
"name": "SQLAlchemy",
"specs": [
[
"==",
"2.0.25"
]
]
},
{
"name": "asyncmy",
"specs": [
[
"==",
"0.2.9"
]
]
},
{
"name": "aiosqlite",
"specs": [
[
"==",
"0.20.0"
]
]
}
],
"lcname": "xiaoapi"
}
JSON
