<div align="center">
<a href="https://kiramibot.dev/">
<p>
<img src="https://raw.githubusercontent.com/A-kirami/KiramiBot/main/assets/logo.svg" width="180" height="180" alt="KiramiBot Logo">
</p>
<p>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/A-kirami/KiramiBot/main/assets/logo-text-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/A-kirami/KiramiBot/main/assets/logo-text-light.svg">
<img src="assets/logo-text-light.svg" alt="KiramiBot Text" width="200" />
</picture>
</p>
</a>
<p>✨ 简明轻快的聊天机器人应用 ✨</p>
</div>
<p align="center">
<a href="https://raw.githubusercontent.com/A-kirami/KiramiBot/main/LICENSE">
<img src="https://img.shields.io/github/license/A-kirami/KiramiBot" alt="license">
</a>
<a href="https://pypi.python.org/pypi/kiramibot">
<img src="https://img.shields.io/pypi/v/kiramibot?logo=python&logoColor=edb641" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641" alt="python">
<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641" alt="black">
</a>
<a href="https://github.com/Microsoft/pyright">
<img src="https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641" alt="pyright">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="ruff">
</a>
<br />
<a href="https://results.pre-commit.ci/latest/github/A-kirami/KiramiBot/main">
<img src="https://results.pre-commit.ci/badge/github/A-kirami/KiramiBot/main.svg" alt="pre-commit" />
</a>
<a href="https://github.com/A-kirami/KiramiBot/actions/workflows/pyright.yml">
<img src="https://github.com/A-kirami/KiramiBot/actions/workflows/pyright.yml/badge.svg?branch=main&event=push" alt="pyright">
</a>
<a href="https://github.com/A-kirami/KiramiBot/actions/workflows/ruff.yml">
<img src="https://github.com/A-kirami/KiramiBot/actions/workflows/ruff.yml/badge.svg?branch=main&event=push" alt="ruff">
</a>
<br />
<a href="https://kiramibot.dev" target="__blank">
<strong>📖 官方文档</strong>
</a>
|
<a href="https://kiramibot.dev/docs/guide/start/installation" target="__blank">
<strong>🚀 快速开始</strong>
</a>
|
<a href="https://qm.qq.com/q/7OD95ZDCMM" target="__blank">
<strong>💬 讨论交流</strong>
</a>
</p>
## ⭐️ 简介
KiramiBot 是一个功能强大的机器人框架，它可以帮助你创建自定义的聊天机器人，用于自动化任务、聊天交互和更多用途。
不论你是开发者还是爱好者，KiramiBot 提供了一个灵活而强大的平台，让你轻松构建自己的机器人应用。
## ✨ 特性
- 🎁 **开箱即用**
无门槛一键安装，无需复杂配置，小白也能轻松上手。
- 🎛️ **插件管理**
非侵入式插件管理系统，支持精细的功能和权限控制，更易于维护和管理。
- 🤝 **开发友好**
具备完整类型注解，包含常用功能模块，助力开发者专注于核心功能。
- 🍀 **生态兼容**
原生支持 **[NoneBot2](https://v2.nonebot.dev/)** 插件，无需修改代码即可平滑迁移项目。
## 🚀 开始
> [!NOTE]
> 需要 Python 3.10 或更高版本，以及 mongoDB 数据库。
### 安装 Kirami CLI
#### Linux, macOS, Windows (WSL)
```bash
curl -sSL https://install.kiramibot.dev | python3 -
```
#### Windows (Powershell)
```powershell
(Invoke-WebRequest -Uri https://install.kiramibot.dev -UseBasicParsing).Content | py -
```
### 创建项目
```bash
kirami create
```
### 运行项目
```bash
kirami run
```
## 📋 路线图
请参阅 [Projects](https://github.com/users/A-kirami/projects/6)
## 🤝 贡献
请参阅[贡献指南](./.github/CONTRIBUTING.md)
## 🎊 活动
## 📄 许可证
Code: AGPL-3.0 - 2023 - Akirami
Logo: CC-BY-NC-ND, Designs by Akirami
Raw data
{
"_id": null,
"home_page": "https://kiramibot.dev",
"name": "KiramiBot",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "kirami, bot, chatbot, onebot",
"author": null,
"author_email": "Akirami <akiramiaya@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/a6/25/698100a8bc3e9fe0e9373962257bfbdc8cddb3c512706a028398ce0acaa9/kiramibot-0.3.5.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <a href=\"https://kiramibot.dev/\">\n <p>\n <img src=\"https://raw.githubusercontent.com/A-kirami/KiramiBot/main/assets/logo.svg\" width=\"180\" height=\"180\" alt=\"KiramiBot Logo\">\n </p>\n <p>\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/A-kirami/KiramiBot/main/assets/logo-text-dark.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/A-kirami/KiramiBot/main/assets/logo-text-light.svg\">\n <img src=\"assets/logo-text-light.svg\" alt=\"KiramiBot Text\" width=\"200\" />\n </picture>\n </p>\n </a>\n <p>\u2728 \u7b80\u660e\u8f7b\u5feb\u7684\u804a\u5929\u673a\u5668\u4eba\u5e94\u7528 \u2728</p>\n</div>\n\n<p align=\"center\">\n <a href=\"https://raw.githubusercontent.com/A-kirami/KiramiBot/main/LICENSE\">\n <img src=\"https://img.shields.io/github/license/A-kirami/KiramiBot\" alt=\"license\">\n </a>\n <a href=\"https://pypi.python.org/pypi/kiramibot\">\n <img src=\"https://img.shields.io/pypi/v/kiramibot?logo=python&logoColor=edb641\" alt=\"pypi\">\n </a>\n <img src=\"https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641\" alt=\"python\">\n <a href=\"https://github.com/psf/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641\" alt=\"black\">\n </a>\n <a href=\"https://github.com/Microsoft/pyright\">\n <img src=\"https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641\" alt=\"pyright\">\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\" alt=\"ruff\">\n </a>\n <br />\n <a href=\"https://results.pre-commit.ci/latest/github/A-kirami/KiramiBot/main\">\n <img src=\"https://results.pre-commit.ci/badge/github/A-kirami/KiramiBot/main.svg\" alt=\"pre-commit\" />\n </a>\n <a href=\"https://github.com/A-kirami/KiramiBot/actions/workflows/pyright.yml\">\n <img src=\"https://github.com/A-kirami/KiramiBot/actions/workflows/pyright.yml/badge.svg?branch=main&event=push\" alt=\"pyright\">\n </a>\n <a href=\"https://github.com/A-kirami/KiramiBot/actions/workflows/ruff.yml\">\n <img src=\"https://github.com/A-kirami/KiramiBot/actions/workflows/ruff.yml/badge.svg?branch=main&event=push\" alt=\"ruff\">\n </a>\n <br />\n <a href=\"https://kiramibot.dev\" target=\"__blank\">\n <strong>\ud83d\udcd6 \u5b98\u65b9\u6587\u6863</strong>\n </a>\n | \n <a href=\"https://kiramibot.dev/docs/guide/start/installation\" target=\"__blank\">\n <strong>\ud83d\ude80 \u5feb\u901f\u5f00\u59cb</strong>\n </a>\n | \n <a href=\"https://qm.qq.com/q/7OD95ZDCMM\" target=\"__blank\">\n <strong>\ud83d\udcac \u8ba8\u8bba\u4ea4\u6d41</strong>\n </a>\n</p>\n\n## \u2b50\ufe0f \u7b80\u4ecb\n\nKiramiBot \u662f\u4e00\u4e2a\u529f\u80fd\u5f3a\u5927\u7684\u673a\u5668\u4eba\u6846\u67b6\uff0c\u5b83\u53ef\u4ee5\u5e2e\u52a9\u4f60\u521b\u5efa\u81ea\u5b9a\u4e49\u7684\u804a\u5929\u673a\u5668\u4eba\uff0c\u7528\u4e8e\u81ea\u52a8\u5316\u4efb\u52a1\u3001\u804a\u5929\u4ea4\u4e92\u548c\u66f4\u591a\u7528\u9014\u3002\n\n\u4e0d\u8bba\u4f60\u662f\u5f00\u53d1\u8005\u8fd8\u662f\u7231\u597d\u8005\uff0cKiramiBot \u63d0\u4f9b\u4e86\u4e00\u4e2a\u7075\u6d3b\u800c\u5f3a\u5927\u7684\u5e73\u53f0\uff0c\u8ba9\u4f60\u8f7b\u677e\u6784\u5efa\u81ea\u5df1\u7684\u673a\u5668\u4eba\u5e94\u7528\u3002\n\n## \u2728 \u7279\u6027\n\n- \ud83c\udf81 **\u5f00\u7bb1\u5373\u7528**\n\n \u65e0\u95e8\u69db\u4e00\u952e\u5b89\u88c5\uff0c\u65e0\u9700\u590d\u6742\u914d\u7f6e\uff0c\u5c0f\u767d\u4e5f\u80fd\u8f7b\u677e\u4e0a\u624b\u3002\n\n- \ud83c\udf9b\ufe0f **\u63d2\u4ef6\u7ba1\u7406**\n\n \u975e\u4fb5\u5165\u5f0f\u63d2\u4ef6\u7ba1\u7406\u7cfb\u7edf\uff0c\u652f\u6301\u7cbe\u7ec6\u7684\u529f\u80fd\u548c\u6743\u9650\u63a7\u5236\uff0c\u66f4\u6613\u4e8e\u7ef4\u62a4\u548c\u7ba1\u7406\u3002\n\n- \ud83e\udd1d **\u5f00\u53d1\u53cb\u597d**\n\n \u5177\u5907\u5b8c\u6574\u7c7b\u578b\u6ce8\u89e3\uff0c\u5305\u542b\u5e38\u7528\u529f\u80fd\u6a21\u5757\uff0c\u52a9\u529b\u5f00\u53d1\u8005\u4e13\u6ce8\u4e8e\u6838\u5fc3\u529f\u80fd\u3002\n\n- \ud83c\udf40 **\u751f\u6001\u517c\u5bb9**\n\n \u539f\u751f\u652f\u6301 **[NoneBot2](https://v2.nonebot.dev/)** \u63d2\u4ef6\uff0c\u65e0\u9700\u4fee\u6539\u4ee3\u7801\u5373\u53ef\u5e73\u6ed1\u8fc1\u79fb\u9879\u76ee\u3002\n\n## \ud83d\ude80 \u5f00\u59cb\n\n> [!NOTE]\n> \u9700\u8981 Python 3.10 \u6216\u66f4\u9ad8\u7248\u672c\uff0c\u4ee5\u53ca mongoDB \u6570\u636e\u5e93\u3002\n\n### \u5b89\u88c5 Kirami CLI\n\n#### Linux, macOS, Windows (WSL)\n\n```bash\ncurl -sSL https://install.kiramibot.dev | python3 -\n```\n\n#### Windows (Powershell)\n\n```powershell\n(Invoke-WebRequest -Uri https://install.kiramibot.dev -UseBasicParsing).Content | py -\n```\n\n### \u521b\u5efa\u9879\u76ee\n\n```bash\nkirami create\n```\n\n### \u8fd0\u884c\u9879\u76ee\n\n```bash\nkirami run\n```\n\n## \ud83d\udccb \u8def\u7ebf\u56fe\n\n\u8bf7\u53c2\u9605 [Projects](https://github.com/users/A-kirami/projects/6)\n\n## \ud83e\udd1d \u8d21\u732e\n\n\u8bf7\u53c2\u9605[\u8d21\u732e\u6307\u5357](./.github/CONTRIBUTING.md)\n\n## \ud83c\udf8a \u6d3b\u52a8\n\n![Alt](https://repobeats.axiom.co/api/embed/4cdc60f22b220e807018a8e4a19226bb942f6331.svg \"Repobeats analytics image\")\n\n## \ud83d\udcc4 \u8bb8\u53ef\u8bc1\n\nCode: AGPL-3.0 - 2023 - Akirami\n\nLogo: CC-BY-NC-ND, Designs by Akirami\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "\ud83c\udf1f \u8bfb\u4f5c Kirami\uff0c\u5199\u4f5c\u661f\u89c1\uff0c\u7b80\u660e\u8f7b\u5feb\u7684\u804a\u5929\u673a\u5668\u4eba\u5e94\u7528\u3002",
"version": "0.3.5",
"project_urls": {
"Documentation": "https://kiramibot.dev/docs",
"Homepage": "https://kiramibot.dev",
"Repository": "https://github.com/A-kirami/KiramiBot"
},
"split_keywords": [
"kirami",
" bot",
" chatbot",
" onebot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7c003dc8e9494b6540265c71e7d8846b3ebc9272147fca1fc086cab073b058c9",
"md5": "825681febf648c9ca5eb1071679f8187",
"sha256": "5cdd8a6aa92e6ef5bd062317afbdf3ddedc29d134e42decfdbd7ec939d05df2a"
},
"downloads": -1,
"filename": "kiramibot-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "825681febf648c9ca5eb1071679f8187",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 105229,
"upload_time": "2024-08-02T08:19:22",
"upload_time_iso_8601": "2024-08-02T08:19:22.962530Z",
"url": "https://files.pythonhosted.org/packages/7c/00/3dc8e9494b6540265c71e7d8846b3ebc9272147fca1fc086cab073b058c9/kiramibot-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a625698100a8bc3e9fe0e9373962257bfbdc8cddb3c512706a028398ce0acaa9",
"md5": "6bb3edf625ce98ea5764d28ca034d9be",
"sha256": "6d2927000ada13bba6d991cd1deb1f6683b720e0115f1779d58adb3783bcf135"
},
"downloads": -1,
"filename": "kiramibot-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "6bb3edf625ce98ea5764d28ca034d9be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 88152,
"upload_time": "2024-08-02T08:19:24",
"upload_time_iso_8601": "2024-08-02T08:19:24.386003Z",
"url": "https://files.pythonhosted.org/packages/a6/25/698100a8bc3e9fe0e9373962257bfbdc8cddb3c512706a028398ce0acaa9/kiramibot-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 08:19:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "A-kirami",
"github_project": "KiramiBot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kiramibot"
}
JSON
