Metadata-Version: 2.1
Name: khy-os
Version: 0.1.16
Summary: Khy OS — AI platform operating system with an extensible default app runtime
Author-email: khy-qqb <2578974124@qq.com>
License: GPL-3.0-only
Project-URL: Homepage, https://khyquant.top
Project-URL: Documentation, https://khyquant.top/docs
Project-URL: Repository, https://github.com/khyquant/khy-quant
Project-URL: Issues, https://github.com/khyquant/khy-quant/issues
Keywords: khy,ai-os,agent-os,platform-cli,extensible-runtime
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: JavaScript
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests<3.0.0,>=2.25.0
Requires-Dist: cffi<3.0.0,>=1.15.0
Provides-Extra: data
Requires-Dist: akshare<2.0.0,>=1.12.0; extra == "data"
Requires-Dist: pandas<3.0.0,>=2.0.0; extra == "data"
Requires-Dist: numpy<3.0.0,>=1.24.0; extra == "data"
Provides-Extra: ml
Requires-Dist: khy-os[data]; extra == "ml"
Requires-Dist: scikit-learn==1.8.0; extra == "ml"
Requires-Dist: xgboost==3.2.0; extra == "ml"
Requires-Dist: lightgbm==4.6.0; extra == "ml"
Requires-Dist: joblib==1.5.3; extra == "ml"
Requires-Dist: scipy<2.0.0,>=1.10.0; extra == "ml"
Requires-Dist: ta<1.0.0,>=0.11.0; extra == "ml"
Requires-Dist: tqdm<5.0.0,>=4.65.0; extra == "ml"
Requires-Dist: pyyaml<7.0.0,>=6.0; extra == "ml"
Requires-Dist: loguru<1.0.0,>=0.7.0; extra == "ml"
Provides-Extra: doc
Requires-Dist: pdf2docx<1.0.0,>=0.5.6; extra == "doc"
Requires-Dist: pytesseract<1.0.0,>=0.3.10; extra == "doc"
Requires-Dist: Pillow<12.0.0,>=10.0.0; extra == "doc"
Provides-Extra: frontend
Requires-Dist: khy-quant-frontend<3.0.0,>=1.6.0; extra == "frontend"
Provides-Extra: backend
Requires-Dist: khy-quant-backend<3.0.0,>=1.6.0; extra == "backend"
Provides-Extra: full
Requires-Dist: khy-os[data]; extra == "full"
Requires-Dist: khy-os[ml]; extra == "full"
Requires-Dist: khy-os[doc]; extra == "full"
Provides-Extra: all
Requires-Dist: khy-os[full]; extra == "all"
Provides-Extra: local-llm
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pytest; extra == "dev"

# KHY OS

KHY OS 是一个以 `khy` 为入口的 AI 平台 CLI 运行时，默认内置应用为 `khyquant`。

- 平台主命令：`khy`
- 兼容命令：`khyquant`、`khy-quant`、`khy-os`

## 快速开始

```bash
python -m pip install -U khy-os
khy --version
khy doctor
```

进入交互：

```bash
khy
```

## 常用命令

```bash
khy gateway status
khy gateway model
khy models list
khy db status
khy guanli
```

升级：

```bash
python -m pip install --upgrade khy-os
```

## 文档导航

优先阅读：

- [KHY OS 使用说明（CLI 精简版 / 对外）](docs/guides/KHY_OS_USER_GUIDE_CLI_ONLY.md)
- [KHY OS 使用说明（完整版 / 内部）](docs/guides/KHY_OS_USER_GUIDE.md)
- [KHY OS 开发文档（中文）](docs/guides/KHY_OS_DEVELOPER_GUIDE.md)
- [KHY OS 测试文档（中文）](docs/guides/KHY_OS_TESTING_GUIDE.md)
- [KHY OS 学习文档（中文）](docs/guides/KHY_OS_LEARNING_GUIDE.md)

专项文档：

- [AI 管理页访问与登录说明](docs/guides/AI_MANAGEMENT_ACCESS_AND_LOGIN.md)
- [pip 安装目录结构与源码映射参考](docs/guides/PIP_INSTALL_LAYOUT_REFERENCE.md)
- [pip Docker Bundle 部署指南](docs/guides/PIP_DOCKER_BUNDLE_DEPLOY.md)
- [环境要求](docs/guides/ENV_REQUIREMENTS.md)
- [核心架构](docs/architecture/CORE_ARCHITECTURE.md)

## 开发与发布（简版）

```bash
python3 -m pip install -e ".[dev]"
npm install
npm --prefix frontend install
npm --prefix ai-frontend install
npm run check:version-sync
npm --prefix backend test
```

版本发布前必须保证以下三个版本一致：

1. `khy_quant/__init__.py`
2. `pyproject.toml`
3. `backend/package.json`

## 说明

- pip 包不会内置大模型权重或大型推理二进制（如 `.gguf`）。
- Windows 首次使用建议验证一次 `khy guanli`，确保管理页可正常打开。

## 许可证

本项目使用 `GPL-3.0-only` 许可证，详见仓库根目录 `LICENSE`。
