nonebot-adapter-mirai


Namenonebot-adapter-mirai JSON
Version 2.3.1 PyPI version JSON
download
home_pagehttps://nonebot.dev/
SummaryMirai Api HTTP adapter for nonebot2
upload_time2024-05-18 07:08:38
maintainerNone
docs_urlNone
authorNone
requires_python<4.0.0,>=3.9.0
licenseAGPL-3.0-or-later
keywords bot qq qqbot mirai
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <a href="https://nonebot.dev/"><img src="https://camo.githubusercontent.com/32db41bc55fa37e0d0085e4fd70e4e74fd34307f6bb4ebdad235bd1b0c8f4126/68747470733a2f2f6e6f6e65626f742e6465762f6c6f676f2e706e67" width="200" height="200" alt="nonebot"></a>
</p>

<div align="center">

# NoneBot-Adapter-Mirai

_✨ mirai-api-http v2 协议适配 ✨_

</div>

> [!NOTE]
> Mirai 及 mirai-api-http 现处于停滞更新状态
> 
> 本项目仅为仍然使用 mirai-api-http 的用户提供支持


## 配置

修改 NoneBot 配置文件 `.env` 或者 `.env.*`。

### Driver

参考 [driver](https://nonebot.dev/docs/appendices/config#driver) 配置项,添加 `HTTPClient` 和 `WebSocketClient` 支持。

如:

```dotenv
DRIVER=~httpx+~websockets
```

或

```dotenv
DRIVER=~aiohttp
```

### MIRAI_CLIENTS

配置连接配置,如:

```dotenv
MIRAI_CLIENTS='
[
  {
    "host": "localhost",
    "port": "8080",
    "account": 1234567890,
    "verify_key": "xxx"
  }
]
'
```

`host` 与 `port` 为 mirai-api-http 服务的监听地址与端口,

`account` 为当前机器人的 QQ 号,

`verify_key` 为 mirai-api-http 的 `verifyKey`。

## 相关项目/鸣谢

- [mirai-api-http](https://github.com/project-mirai/mirai-api-http)
- [Ariadne](https://github.com/GraiaProject/Ariadne)

            

Raw data

            {
    "_id": null,
    "home_page": "https://nonebot.dev/",
    "name": "nonebot-adapter-mirai",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0.0,>=3.9.0",
    "maintainer_email": null,
    "keywords": "bot, qq, qqbot, mirai",
    "author": null,
    "author_email": "rf_tar_railt <rf_tar_railt@qq.com>, Mix <admin@yami.im>, yanyongyu <yyy@nonebot.dev>",
    "download_url": "https://files.pythonhosted.org/packages/aa/34/2f27d329ecd931ada11842d4e25709426744e0f7cb008ed5441e227b1f7d/nonebot_adapter_mirai-2.3.1.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <a href=\"https://nonebot.dev/\"><img src=\"https://camo.githubusercontent.com/32db41bc55fa37e0d0085e4fd70e4e74fd34307f6bb4ebdad235bd1b0c8f4126/68747470733a2f2f6e6f6e65626f742e6465762f6c6f676f2e706e67\" width=\"200\" height=\"200\" alt=\"nonebot\"></a>\n</p>\n\n<div align=\"center\">\n\n# NoneBot-Adapter-Mirai\n\n_\u2728 mirai-api-http v2 \u534f\u8bae\u9002\u914d \u2728_\n\n</div>\n\n> [!NOTE]\n> Mirai \u53ca mirai-api-http \u73b0\u5904\u4e8e\u505c\u6ede\u66f4\u65b0\u72b6\u6001\n> \n> \u672c\u9879\u76ee\u4ec5\u4e3a\u4ecd\u7136\u4f7f\u7528 mirai-api-http \u7684\u7528\u6237\u63d0\u4f9b\u652f\u6301\n\n\n## \u914d\u7f6e\n\n\u4fee\u6539 NoneBot \u914d\u7f6e\u6587\u4ef6 `.env` \u6216\u8005 `.env.*`\u3002\n\n### Driver\n\n\u53c2\u8003 [driver](https://nonebot.dev/docs/appendices/config#driver) \u914d\u7f6e\u9879\uff0c\u6dfb\u52a0 `HTTPClient` \u548c `WebSocketClient` \u652f\u6301\u3002\n\n\u5982\uff1a\n\n```dotenv\nDRIVER=~httpx+~websockets\n```\n\n\u6216\n\n```dotenv\nDRIVER=~aiohttp\n```\n\n### MIRAI_CLIENTS\n\n\u914d\u7f6e\u8fde\u63a5\u914d\u7f6e\uff0c\u5982\uff1a\n\n```dotenv\nMIRAI_CLIENTS='\n[\n  {\n    \"host\": \"localhost\",\n    \"port\": \"8080\",\n    \"account\": 1234567890,\n    \"verify_key\": \"xxx\"\n  }\n]\n'\n```\n\n`host` \u4e0e `port` \u4e3a mirai-api-http \u670d\u52a1\u7684\u76d1\u542c\u5730\u5740\u4e0e\u7aef\u53e3\uff0c\n\n`account` \u4e3a\u5f53\u524d\u673a\u5668\u4eba\u7684 QQ \u53f7\uff0c\n\n`verify_key` \u4e3a mirai-api-http \u7684 `verifyKey`\u3002\n\n## \u76f8\u5173\u9879\u76ee/\u9e23\u8c22\n\n- [mirai-api-http](https://github.com/project-mirai/mirai-api-http)\n- [Ariadne](https://github.com/GraiaProject/Ariadne)\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0-or-later",
    "summary": "Mirai Api HTTP adapter for nonebot2",
    "version": "2.3.1",
    "project_urls": {
        "Documentation": "https://nonebot.dev/",
        "Homepage": "https://nonebot.dev/",
        "Repository": "https://github.com/nonebot/adapter-mirai"
    },
    "split_keywords": [
        "bot",
        " qq",
        " qqbot",
        " mirai"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "498d7d26d61e67e2d4f236fd416dd050a64362066a542308db6be762ff6c7999",
                "md5": "4dd579b721b5fef4399997336d935638",
                "sha256": "ecb562e258facdedfb63d1c898ad1ab589bfc6d9b586cc2afd85eadc757ca7cb"
            },
            "downloads": -1,
            "filename": "nonebot_adapter_mirai-2.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4dd579b721b5fef4399997336d935638",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.9.0",
            "size": 47747,
            "upload_time": "2024-05-18T07:08:36",
            "upload_time_iso_8601": "2024-05-18T07:08:36.531659Z",
            "url": "https://files.pythonhosted.org/packages/49/8d/7d26d61e67e2d4f236fd416dd050a64362066a542308db6be762ff6c7999/nonebot_adapter_mirai-2.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aa342f27d329ecd931ada11842d4e25709426744e0f7cb008ed5441e227b1f7d",
                "md5": "f6f239df5ebd567f7a3f6265cac108bc",
                "sha256": "7c8f52cb6c7c48f54ba4140fedbb5cbff93208393aba41011d06a45cee04f985"
            },
            "downloads": -1,
            "filename": "nonebot_adapter_mirai-2.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f6f239df5ebd567f7a3f6265cac108bc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0.0,>=3.9.0",
            "size": 43992,
            "upload_time": "2024-05-18T07:08:38",
            "upload_time_iso_8601": "2024-05-18T07:08:38.730815Z",
            "url": "https://files.pythonhosted.org/packages/aa/34/2f27d329ecd931ada11842d4e25709426744e0f7cb008ed5441e227b1f7d/nonebot_adapter_mirai-2.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-18 07:08:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nonebot",
    "github_project": "adapter-mirai",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nonebot-adapter-mirai"
}
        
Elapsed time: 0.24156s