Skip to content

Commit

Permalink
Add Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
YangRucheng committed Dec 29, 2024
1 parent b744379 commit 05cc107
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 NoneBot

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
68 changes: 68 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<div align="center">

# NoneBot-Adapter-WXMP

_✨ 微信公众平台客服 协议适配 ✨_

</div>

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

## 安装

```bash
pip install nonebot-adapter-wxmp
```

## 加载适配器

```python
import nonebot
from nonebot.adapters.wxmp import Adapter as WxmpAdapter

nonebot.init()

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

## 配置

### 配置 .env

```dotenv
WXMP_BOTS='
[
{
"appid": "",
"token": "",
"secret": "",
"enable_verify": true
}
]
'
```

## 使用

### 消息推送

URL(服务器地址): `https://example.com/wxmp/revice/<app_id>`
Token(令牌):随意
消息加密方式:明文模式
数据格式:JSON

## 开发进度

- [x] 文字消息
- [ ] 图片消息
- [ ] 图文链接
- [ ] 小程序卡片

0 comments on commit 05cc107

Please sign in to comment.