Metadata-Version: 2.2
Name: nonebot-adapter-chaoxing
Version: 0.0.8
Summary: Nonebot2 Adapter for 超星学习通
Author-email: YangRucheng <admin@yangrucheng.top>
License: MIT
Project-URL: homepage, https://github.com/YangRucheng/nonebot-adapter-chaoxing
Project-URL: repository, https://github.com/YangRucheng/nonebot-adapter-chaoxing
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nonebot2>=2.3.0
Requires-Dist: httpx>=0.28.0

<div align="center">

# NoneBot-Adapter-ChaoXing

_✨ 超星学习通（环信3.0） 协议适配 ✨_

</div>

<p align="center">
  <a href="https://raw.githubusercontent.com/YangRucheng/nonebot-adapter-chaoxing/main/LICENSE">
    <img src="https://img.shields.io/github/license/YangRucheng/nonebot-adapter-chaoxing" alt="license">
  </a>
  <a href="https://pypi.python.org/pypi/nonebot-adapter-chaoxing">
    <img src="https://img.shields.io/pypi/v/nonebot-adapter-chaoxing" alt="pypi">
  </a>
  <img src="https://img.shields.io/badge/python-3.10+-blue" alt="python">
</p>

## 说明

本项目仅自用，代码不符合 [RFC: NoneBot 适配器规范](https://github.com/nonebot/nonebot2/issues/2435)，不会进入 NoneBot 商店。

由于作者只用于 _把学习通接入猫娘_，用不上文本以外的消息类型，所以只实现了文字消息相关的功能。

## 安装

```bash
pip install nonebot-adapter-chaoxing
```
或
```bash
pip install git+https://github.com/YangRucheng/nonebot-adapter-chaoxing.git#egg=nonebot-adapter-chaoxing
```

## 使用

```python
import nonebot
from nonebot.adapters.chaoxing import Adapter as CxAdapter

nonebot.init()

driver = nonebot.get_driver()
driver.register_adapter(CxAdapter)
```

配置 Driver

```dotenv
DRIVER=~fastapi+~httpx
```

配置 Bot

```dotenv
CX_TOKEN="" # 类似于 OneBot 的 access_token
```

## 适配情况

<div align="center">

|          | 接收消息 | 发送消息 |
| -------- | -------- | -------- |
| 文字消息 | ✅        | ✅        |
| 图片消息 | ✅        | ❌        |
| 音频消息 | ✅        | ❌        |

</div>

## 开源协议

[MIT LICENSE](https://github.com/YangRucheng/nonebot-adapter-chaoxing/blob/main/LICENSE)
