# yoapi-cli
WaveYo-API 命令行工具 - 统一的项目管理和插件开发工具
## 📦 功能特性
- 🚀 **项目初始化** - 从GitHub一键初始化WaveYo-API项目
- 🔧 **虚拟环境管理** - 自动创建和管理Python虚拟环境
- 🔌 **插件管理** - 下载、安装、管理插件
- ⚡ **项目运行** - 快速启动开发服务器（支持热重载）
- 📦 **包管理** - 依赖包安装和卸载
- 🎨 **美观界面** - 使用Rich库提供漂亮的命令行界面
## 🛠️ 安装方式
### 使用 pip 安装
```bash
pip install yoapi-cli
```
### 使用 pipx 安装（推荐）
```bash
pipx install yoapi-cli
```
### 从源码安装
```bash
git clone https://github.com/WaveYo/yoapi-cli.git
cd yoapi-cli
pip install -e .
```
## 🚀 快速开始
### 1. 初始化新项目
```bash
# 创建默认名称的项目
yoapi init
# 创建指定名称的项目
yoapi init my-api-project
# 从特定分支初始化
yoapi init --branch develop
```
### 2. 创建虚拟环境
```bash
cd my-api-project
yoapi venv create
```
### 3. 运行项目
```bash
# 正常模式运行
yoapi run
# 热重载模式运行
yoapi run --reload
```
## 📋 命令参考
### 项目初始化
```bash
yoapi init [PROJECT_NAME] [--branch BRANCH]
```
- `PROJECT_NAME`: 项目目录名称（默认为 `waveyo-api-project`）
- `--branch`, `-b`: GitHub分支名称（默认为 `main`）
### 虚拟环境管理
```bash
yoapi venv create
```
### 项目运行
```bash
yoapi run [--reload]
```
- `--reload`, `-r`: 启用热重载模式
### 插件管理
```bash
yoapi plugin download [REPO_NAME]
yoapi plugin list
yoapi plugin remove [PLUGIN_NAME]
yoapi plugin new [PLUGIN_NAME]
```
### 版本信息
```bash
yoapi version
```
## 🏗️ 项目结构
```
yoapi-cli/
├── src/
│ └── yoapi_cli/
│ ├── __init__.py
│ ├── cli.py # 主CLI程序
│ ├── commands/ # 命令模块
│ │ ├── init.py # 项目初始化
│ │ ├── plugin.py # 插件管理
│ │ └── run.py # 运行命令
│ └── utils/ # 工具函数
│ ├── git.py # Git操作
│ └── package.py # 包管理
├── pyproject.toml # 项目配置
├── README.md # 说明文档
└── requirements.txt # 依赖声明
```
## 🔧 开发指南
### 环境设置
```bash
# 克隆项目
git clone https://github.com/WaveYo/yoapi-cli.git
cd yoapi-cli
# 创建虚拟环境
python -m venv .venv
# 激活虚拟环境
# Windows
.venv\Scripts\activate
# Unix/Linux/Mac
source .venv/bin/activate
# 安装开发依赖
pip install -e .[dev]
```
### 运行测试
```bash
pytest tests/
```
#### 测试方法说明
yoapi-cli 使用 pytest 框架进行单元测试，测试覆盖了核心功能：
- **项目初始化测试**：验证从GitHub克隆项目的功能，包括成功初始化、目录冲突处理、Git错误处理等场景
- **包管理器检测**：测试uv和pip的可用性检测逻辑
- **虚拟环境管理**：验证虚拟环境的创建、激活状态检测等功能
- **插件管理**：测试插件的下载、安装、移除等操作
测试使用临时目录进行隔离，确保测试环境干净且不会影响实际文件系统。所有测试都包含详细的错误处理和模拟，确保在各种边界条件下都能正确工作。
测试文件结构：
```
tests/
├── test_cli.py # 主CLI功能测试
└── __pycache__/ # 编译缓存
```
### 代码格式化
```bash
black src/
isort src/
flake8 src/
```
### 构建发布
```bash
# 构建分发包
python -m build
# 上传到PyPI
twine upload dist/*
```
## 📦 打包为可执行文件
使用Nuitka打包为独立可执行文件：
```bash
# 安装Nuitka
pip install nuitka
# 打包为单文件可执行程序
python -m nuitka --onefile --standalone --enable-console --remove-output src/yoapi_cli/cli.py
```
## 🌟 特性详情
### 项目初始化
- 从GitHub克隆WaveYo-API官方仓库
- 支持指定分支和标签
- 自动检测目录冲突
- 提供详细的项目结构预览
### 虚拟环境管理
- 自动检测和优先使用uv包管理器
- 支持标准venv作为备选方案
- 提供清晰的激活指令
- 智能的环境检测机制
### 插件管理
- 符合yoapi-plugin-xxx命名规范
- 支持从GitHub下载插件
- 插件依赖自动安装
- 完整的插件生命周期管理
## 🤝 贡献指南
1. Fork 项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建Pull Request
## 📄 许可证
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情
## 📞 支持
如有问题或建议，请创建 [Issue](https://github.com/WaveYo/yoapi-cli/issues) 或联系开发团队。
---
*版本: 0.1.8*
*最后更新: 2025-09-04*
Raw data
{
"_id": null,
"home_page": null,
"name": "yoapi-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "fastapi, cli, plugin, api, backend",
"author": null,
"author_email": "WaveYo Team <contact@waveyo.com>",
"download_url": "https://files.pythonhosted.org/packages/3b/99/089fa3cb554508d95af6694a83d61262ff6beef4a6d64c59cea5acf42734/yoapi_cli-0.1.8.tar.gz",
"platform": null,
"description": "# yoapi-cli\r\n\r\nWaveYo-API \u547d\u4ee4\u884c\u5de5\u5177 - \u7edf\u4e00\u7684\u9879\u76ee\u7ba1\u7406\u548c\u63d2\u4ef6\u5f00\u53d1\u5de5\u5177\r\n\r\n## \ud83d\udce6 \u529f\u80fd\u7279\u6027\r\n\r\n- \ud83d\ude80 **\u9879\u76ee\u521d\u59cb\u5316** - \u4eceGitHub\u4e00\u952e\u521d\u59cb\u5316WaveYo-API\u9879\u76ee\r\n- \ud83d\udd27 **\u865a\u62df\u73af\u5883\u7ba1\u7406** - \u81ea\u52a8\u521b\u5efa\u548c\u7ba1\u7406Python\u865a\u62df\u73af\u5883\r\n- \ud83d\udd0c **\u63d2\u4ef6\u7ba1\u7406** - \u4e0b\u8f7d\u3001\u5b89\u88c5\u3001\u7ba1\u7406\u63d2\u4ef6\r\n- \u26a1 **\u9879\u76ee\u8fd0\u884c** - \u5feb\u901f\u542f\u52a8\u5f00\u53d1\u670d\u52a1\u5668\uff08\u652f\u6301\u70ed\u91cd\u8f7d\uff09\r\n- \ud83d\udce6 **\u5305\u7ba1\u7406** - \u4f9d\u8d56\u5305\u5b89\u88c5\u548c\u5378\u8f7d\r\n- \ud83c\udfa8 **\u7f8e\u89c2\u754c\u9762** - \u4f7f\u7528Rich\u5e93\u63d0\u4f9b\u6f02\u4eae\u7684\u547d\u4ee4\u884c\u754c\u9762\r\n\r\n## \ud83d\udee0\ufe0f \u5b89\u88c5\u65b9\u5f0f\r\n\r\n### \u4f7f\u7528 pip \u5b89\u88c5\r\n\r\n```bash\r\npip install yoapi-cli\r\n```\r\n\r\n### \u4f7f\u7528 pipx \u5b89\u88c5\uff08\u63a8\u8350\uff09\r\n\r\n```bash\r\npipx install yoapi-cli\r\n```\r\n\r\n### \u4ece\u6e90\u7801\u5b89\u88c5\r\n\r\n```bash\r\ngit clone https://github.com/WaveYo/yoapi-cli.git\r\ncd yoapi-cli\r\npip install -e .\r\n```\r\n\r\n## \ud83d\ude80 \u5feb\u901f\u5f00\u59cb\r\n\r\n### 1. \u521d\u59cb\u5316\u65b0\u9879\u76ee\r\n\r\n```bash\r\n# \u521b\u5efa\u9ed8\u8ba4\u540d\u79f0\u7684\u9879\u76ee\r\nyoapi init\r\n\r\n# \u521b\u5efa\u6307\u5b9a\u540d\u79f0\u7684\u9879\u76ee\r\nyoapi init my-api-project\r\n\r\n# \u4ece\u7279\u5b9a\u5206\u652f\u521d\u59cb\u5316\r\nyoapi init --branch develop\r\n```\r\n\r\n### 2. \u521b\u5efa\u865a\u62df\u73af\u5883\r\n\r\n```bash\r\ncd my-api-project\r\nyoapi venv create\r\n```\r\n\r\n### 3. \u8fd0\u884c\u9879\u76ee\r\n\r\n```bash\r\n# \u6b63\u5e38\u6a21\u5f0f\u8fd0\u884c\r\nyoapi run\r\n\r\n# \u70ed\u91cd\u8f7d\u6a21\u5f0f\u8fd0\u884c\r\nyoapi run --reload\r\n```\r\n\r\n## \ud83d\udccb \u547d\u4ee4\u53c2\u8003\r\n\r\n### \u9879\u76ee\u521d\u59cb\u5316\r\n\r\n```bash\r\nyoapi init [PROJECT_NAME] [--branch BRANCH]\r\n```\r\n\r\n- `PROJECT_NAME`: \u9879\u76ee\u76ee\u5f55\u540d\u79f0\uff08\u9ed8\u8ba4\u4e3a `waveyo-api-project`\uff09\r\n- `--branch`, `-b`: GitHub\u5206\u652f\u540d\u79f0\uff08\u9ed8\u8ba4\u4e3a `main`\uff09\r\n\r\n### \u865a\u62df\u73af\u5883\u7ba1\u7406\r\n\r\n```bash\r\nyoapi venv create\r\n```\r\n\r\n### \u9879\u76ee\u8fd0\u884c\r\n\r\n```bash\r\nyoapi run [--reload]\r\n```\r\n\r\n- `--reload`, `-r`: \u542f\u7528\u70ed\u91cd\u8f7d\u6a21\u5f0f\r\n\r\n### \u63d2\u4ef6\u7ba1\u7406\r\n\r\n```bash\r\nyoapi plugin download [REPO_NAME]\r\nyoapi plugin list\r\nyoapi plugin remove [PLUGIN_NAME]\r\nyoapi plugin new [PLUGIN_NAME]\r\n```\r\n\r\n### \u7248\u672c\u4fe1\u606f\r\n\r\n```bash\r\nyoapi version\r\n```\r\n\r\n## \ud83c\udfd7\ufe0f \u9879\u76ee\u7ed3\u6784\r\n\r\n```\r\nyoapi-cli/\r\n\u251c\u2500\u2500 src/\r\n\u2502 \u2514\u2500\u2500 yoapi_cli/\r\n\u2502 \u251c\u2500\u2500 __init__.py\r\n\u2502 \u251c\u2500\u2500 cli.py # \u4e3bCLI\u7a0b\u5e8f\r\n\u2502 \u251c\u2500\u2500 commands/ # \u547d\u4ee4\u6a21\u5757\r\n\u2502 \u2502 \u251c\u2500\u2500 init.py # \u9879\u76ee\u521d\u59cb\u5316\r\n\u2502 \u2502 \u251c\u2500\u2500 plugin.py # \u63d2\u4ef6\u7ba1\u7406\r\n\u2502 \u2502 \u2514\u2500\u2500 run.py # \u8fd0\u884c\u547d\u4ee4\r\n\u2502 \u2514\u2500\u2500 utils/ # \u5de5\u5177\u51fd\u6570\r\n\u2502 \u251c\u2500\u2500 git.py # Git\u64cd\u4f5c\r\n\u2502 \u2514\u2500\u2500 package.py # \u5305\u7ba1\u7406\r\n\u251c\u2500\u2500 pyproject.toml # \u9879\u76ee\u914d\u7f6e\r\n\u251c\u2500\u2500 README.md # \u8bf4\u660e\u6587\u6863\r\n\u2514\u2500\u2500 requirements.txt # \u4f9d\u8d56\u58f0\u660e\r\n```\r\n\r\n## \ud83d\udd27 \u5f00\u53d1\u6307\u5357\r\n\r\n### \u73af\u5883\u8bbe\u7f6e\r\n\r\n```bash\r\n# \u514b\u9686\u9879\u76ee\r\ngit clone https://github.com/WaveYo/yoapi-cli.git\r\ncd yoapi-cli\r\n\r\n# \u521b\u5efa\u865a\u62df\u73af\u5883\r\npython -m venv .venv\r\n\r\n# \u6fc0\u6d3b\u865a\u62df\u73af\u5883\r\n# Windows\r\n.venv\\Scripts\\activate\r\n# Unix/Linux/Mac\r\nsource .venv/bin/activate\r\n\r\n# \u5b89\u88c5\u5f00\u53d1\u4f9d\u8d56\r\npip install -e .[dev]\r\n```\r\n\r\n### \u8fd0\u884c\u6d4b\u8bd5\r\n\r\n```bash\r\npytest tests/\r\n```\r\n\r\n#### \u6d4b\u8bd5\u65b9\u6cd5\u8bf4\u660e\r\n\r\nyoapi-cli \u4f7f\u7528 pytest \u6846\u67b6\u8fdb\u884c\u5355\u5143\u6d4b\u8bd5\uff0c\u6d4b\u8bd5\u8986\u76d6\u4e86\u6838\u5fc3\u529f\u80fd\uff1a\r\n\r\n- **\u9879\u76ee\u521d\u59cb\u5316\u6d4b\u8bd5**\uff1a\u9a8c\u8bc1\u4eceGitHub\u514b\u9686\u9879\u76ee\u7684\u529f\u80fd\uff0c\u5305\u62ec\u6210\u529f\u521d\u59cb\u5316\u3001\u76ee\u5f55\u51b2\u7a81\u5904\u7406\u3001Git\u9519\u8bef\u5904\u7406\u7b49\u573a\u666f\r\n- **\u5305\u7ba1\u7406\u5668\u68c0\u6d4b**\uff1a\u6d4b\u8bd5uv\u548cpip\u7684\u53ef\u7528\u6027\u68c0\u6d4b\u903b\u8f91\r\n- **\u865a\u62df\u73af\u5883\u7ba1\u7406**\uff1a\u9a8c\u8bc1\u865a\u62df\u73af\u5883\u7684\u521b\u5efa\u3001\u6fc0\u6d3b\u72b6\u6001\u68c0\u6d4b\u7b49\u529f\u80fd\r\n- **\u63d2\u4ef6\u7ba1\u7406**\uff1a\u6d4b\u8bd5\u63d2\u4ef6\u7684\u4e0b\u8f7d\u3001\u5b89\u88c5\u3001\u79fb\u9664\u7b49\u64cd\u4f5c\r\n\r\n\u6d4b\u8bd5\u4f7f\u7528\u4e34\u65f6\u76ee\u5f55\u8fdb\u884c\u9694\u79bb\uff0c\u786e\u4fdd\u6d4b\u8bd5\u73af\u5883\u5e72\u51c0\u4e14\u4e0d\u4f1a\u5f71\u54cd\u5b9e\u9645\u6587\u4ef6\u7cfb\u7edf\u3002\u6240\u6709\u6d4b\u8bd5\u90fd\u5305\u542b\u8be6\u7ec6\u7684\u9519\u8bef\u5904\u7406\u548c\u6a21\u62df\uff0c\u786e\u4fdd\u5728\u5404\u79cd\u8fb9\u754c\u6761\u4ef6\u4e0b\u90fd\u80fd\u6b63\u786e\u5de5\u4f5c\u3002\r\n\r\n\u6d4b\u8bd5\u6587\u4ef6\u7ed3\u6784\uff1a\r\n```\r\ntests/\r\n\u251c\u2500\u2500 test_cli.py # \u4e3bCLI\u529f\u80fd\u6d4b\u8bd5\r\n\u2514\u2500\u2500 __pycache__/ # \u7f16\u8bd1\u7f13\u5b58\r\n```\r\n\r\n### \u4ee3\u7801\u683c\u5f0f\u5316\r\n\r\n```bash\r\nblack src/\r\nisort src/\r\nflake8 src/\r\n```\r\n\r\n### \u6784\u5efa\u53d1\u5e03\r\n\r\n```bash\r\n# \u6784\u5efa\u5206\u53d1\u5305\r\npython -m build\r\n\r\n# \u4e0a\u4f20\u5230PyPI\r\ntwine upload dist/*\r\n```\r\n\r\n## \ud83d\udce6 \u6253\u5305\u4e3a\u53ef\u6267\u884c\u6587\u4ef6\r\n\r\n\u4f7f\u7528Nuitka\u6253\u5305\u4e3a\u72ec\u7acb\u53ef\u6267\u884c\u6587\u4ef6\uff1a\r\n\r\n```bash\r\n# \u5b89\u88c5Nuitka\r\npip install nuitka\r\n\r\n# \u6253\u5305\u4e3a\u5355\u6587\u4ef6\u53ef\u6267\u884c\u7a0b\u5e8f\r\npython -m nuitka --onefile --standalone --enable-console --remove-output src/yoapi_cli/cli.py\r\n```\r\n\r\n## \ud83c\udf1f \u7279\u6027\u8be6\u60c5\r\n\r\n### \u9879\u76ee\u521d\u59cb\u5316\r\n\r\n- \u4eceGitHub\u514b\u9686WaveYo-API\u5b98\u65b9\u4ed3\u5e93\r\n- \u652f\u6301\u6307\u5b9a\u5206\u652f\u548c\u6807\u7b7e\r\n- \u81ea\u52a8\u68c0\u6d4b\u76ee\u5f55\u51b2\u7a81\r\n- \u63d0\u4f9b\u8be6\u7ec6\u7684\u9879\u76ee\u7ed3\u6784\u9884\u89c8\r\n\r\n### \u865a\u62df\u73af\u5883\u7ba1\u7406\r\n\r\n- \u81ea\u52a8\u68c0\u6d4b\u548c\u4f18\u5148\u4f7f\u7528uv\u5305\u7ba1\u7406\u5668\r\n- \u652f\u6301\u6807\u51c6venv\u4f5c\u4e3a\u5907\u9009\u65b9\u6848\r\n- \u63d0\u4f9b\u6e05\u6670\u7684\u6fc0\u6d3b\u6307\u4ee4\r\n- \u667a\u80fd\u7684\u73af\u5883\u68c0\u6d4b\u673a\u5236\r\n\r\n### \u63d2\u4ef6\u7ba1\u7406\r\n\r\n- \u7b26\u5408yoapi-plugin-xxx\u547d\u540d\u89c4\u8303\r\n- \u652f\u6301\u4eceGitHub\u4e0b\u8f7d\u63d2\u4ef6\r\n- \u63d2\u4ef6\u4f9d\u8d56\u81ea\u52a8\u5b89\u88c5\r\n- \u5b8c\u6574\u7684\u63d2\u4ef6\u751f\u547d\u5468\u671f\u7ba1\u7406\r\n\r\n## \ud83e\udd1d \u8d21\u732e\u6307\u5357\r\n\r\n1. Fork \u9879\u76ee\r\n2. \u521b\u5efa\u7279\u6027\u5206\u652f (`git checkout -b feature/AmazingFeature`)\r\n3. \u63d0\u4ea4\u66f4\u6539 (`git commit -m 'Add some AmazingFeature'`)\r\n4. \u63a8\u9001\u5230\u5206\u652f (`git push origin feature/AmazingFeature`)\r\n5. \u521b\u5efaPull Request\r\n\r\n## \ud83d\udcc4 \u8bb8\u53ef\u8bc1\r\n\r\n\u672c\u9879\u76ee\u91c7\u7528 MIT \u8bb8\u53ef\u8bc1 - \u67e5\u770b [LICENSE](LICENSE) \u6587\u4ef6\u4e86\u89e3\u8be6\u60c5\r\n\r\n## \ud83d\udcde \u652f\u6301\r\n\r\n\u5982\u6709\u95ee\u9898\u6216\u5efa\u8bae\uff0c\u8bf7\u521b\u5efa [Issue](https://github.com/WaveYo/yoapi-cli/issues) \u6216\u8054\u7cfb\u5f00\u53d1\u56e2\u961f\u3002\r\n\r\n---\r\n\r\n*\u7248\u672c: 0.1.8*\r\n*\u6700\u540e\u66f4\u65b0: 2025-09-04*\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "WaveYo-API Command Line Interface Tool",
"version": "0.1.8",
"project_urls": {
"Documentation": "https://github.com/WaveYo/yoapi-cli#readme",
"Homepage": "https://github.com/WaveYo/yoapi-cli",
"Issues": "https://github.com/WaveYo/yoapi-cli/issues",
"Repository": "https://github.com/WaveYo/yoapi-cli"
},
"split_keywords": [
"fastapi",
" cli",
" plugin",
" api",
" backend"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "598d82becca41bc77ffbeca4d211cfcca366183d2410b43aed962ed1a967c106",
"md5": "b84d05b5aef75606593767809c1b746d",
"sha256": "2c33edae4508efc45ecb05b4fc2c91735bb3d36056e66892e1b32fb23b11cb08"
},
"downloads": -1,
"filename": "yoapi_cli-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b84d05b5aef75606593767809c1b746d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 16020,
"upload_time": "2025-09-06T07:52:04",
"upload_time_iso_8601": "2025-09-06T07:52:04.274241Z",
"url": "https://files.pythonhosted.org/packages/59/8d/82becca41bc77ffbeca4d211cfcca366183d2410b43aed962ed1a967c106/yoapi_cli-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3b99089fa3cb554508d95af6694a83d61262ff6beef4a6d64c59cea5acf42734",
"md5": "62c1696eaed6d38465d3fd09a5131ba6",
"sha256": "0888b6670653eaa0ce25ac7a010298ec6834837fcb385ca5f7a75a24d94a56f4"
},
"downloads": -1,
"filename": "yoapi_cli-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "62c1696eaed6d38465d3fd09a5131ba6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 17424,
"upload_time": "2025-09-06T07:52:23",
"upload_time_iso_8601": "2025-09-06T07:52:23.406215Z",
"url": "https://files.pythonhosted.org/packages/3b/99/089fa3cb554508d95af6694a83d61262ff6beef4a6d64c59cea5acf42734/yoapi_cli-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-06 07:52:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "WaveYo",
"github_project": "yoapi-cli#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "click",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "requests",
"specs": [
[
">=",
"2.25.0"
]
]
},
{
"name": "python-dotenv",
"specs": [
[
">=",
"0.19.0"
]
]
},
{
"name": "GitPython",
"specs": [
[
">=",
"3.1.0"
]
]
},
{
"name": "rich",
"specs": [
[
">=",
"10.0.0"
]
]
},
{
"name": "typer",
"specs": [
[
">=",
"0.9.0"
]
]
},
{
"name": "twine",
"specs": [
[
"==",
"6.2.0"
]
]
}
],
"lcname": "yoapi-cli"
}
JSON
