Metadata-Version: 2.1
Name: KiramiBot
Version: 0.3.4
Summary: 🌟 读作 Kirami，写作星见，简明轻快的聊天机器人应用。
Keywords: kirami bot chatbot onebot
Home-page: https://kiramibot.dev
Author-Email: Akirami <akiramiaya@outlook.com>
License: AGPL-3.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Project-URL: Homepage, https://kiramibot.dev
Project-URL: Repository, https://github.com/A-kirami/KiramiBot
Project-URL: Documentation, https://kiramibot.dev/docs
Requires-Python: <4.0,>=3.10
Requires-Dist: nonebot2[fastapi]==2.1.3
Requires-Dist: nonebot-adapter-onebot==2.3.1
Requires-Dist: typing-extensions>=4.8.0
Requires-Dist: APScheduler>=3.10.4
Requires-Dist: mango-odm>=0.3.2
Requires-Dist: arrow>=1.3.0
Requires-Dist: bidict>=0.22.1
Requires-Dist: cashews>=6.3.0
Requires-Dist: flowery>=0.0.1
Requires-Dist: rich>=13.6.0
Requires-Dist: loguru>=0.7.2
Requires-Dist: tomli>=2.0.1; python_version < "3.11"
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: playwright>=1.38.0
Requires-Dist: httpx[http2]>=0.25.0
Requires-Dist: Jinja2>=3.1.2
Requires-Dist: tenacity>=8.2.3
Requires-Dist: filetype>=1.2.0
Requires-Dist: markdown-it-py[linkify,plugins]>=3.0.0
Requires-Dist: mdit-py-emoji>=0.1.1
Requires-Dist: pygments>=2.16.1
Requires-Dist: yarl>=1.9.2
Description-Content-Type: text/markdown

<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>
  &nbsp;&nbsp;|&nbsp;&nbsp;
  <a href="https://kiramibot.dev/docs/guide/start/installation" target="__blank">
    <strong>🚀 快速开始</strong>
  </a>
  &nbsp;&nbsp;|&nbsp;&nbsp;
  <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)

## 🎊 活动

![Alt](https://repobeats.axiom.co/api/embed/4cdc60f22b220e807018a8e4a19226bb942f6331.svg "Repobeats analytics image")

## 📄 许可证

Code: AGPL-3.0 - 2023 - Akirami

Logo: CC-BY-NC-ND, Designs by Akirami
