<!-- markdownlint-disable MD033 MD036 MD041 -->
<p align="center">
<a href="https://v2.nonebot.dev/"><img src="https://v2.nonebot.dev/logo.png" width="200" height="200" alt="nonebot"></a>
</p>
<div align="center">
# NoneBot Plugin User
_✨ NoneBot 用户插件 ✨_
</div>
<p align="center">
<a href="https://raw.githubusercontent.com/he0119/nonebot-plugin-user/main/LICENSE">
<img src="https://img.shields.io/github/license/he0119/nonebot-plugin-user.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-user">
<img src="https://img.shields.io/pypi/v/nonebot-plugin-user.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="python">
<a href="https://codecov.io/gh/he0119/nonebot-plugin-user">
<img src="https://codecov.io/gh/he0119/nonebot-plugin-user/branch/main/graph/badge.svg?token=jd5ufc1alv"/>
</a>
<a href="https://jq.qq.com/?_wv=1027&k=7zQUpiGp">
<img src="https://img.shields.io/badge/QQ%E7%BE%A4-730374631-orange?style=flat-square" alt="QQ Chat Group">
</a>
</p>
## 简介
## 使用方式
加载插件后发送 `/user`、`/inspect` 或 `/bind`。
### 查看用户信息
通过 user 命令可查看用户信息:
```text
平台名：qq
平台 ID：10000
用户名：uy/sun
创建日期：2023-11-02 04:52:42
```
### 查看会话信息
通过 inspect 命令可查看当前会话信息:
```text
平台名：qq
平台 ID：10000
自身 ID：20000
群组 ID：30000
```
### 绑定用户
通过 bind 命令可将不同用户的数据绑定:
```text
命令 bind 可用于在多个平台间绑定用户数据。绑定过程中，原始平台的用户数据将完全保留，而目标平台的用户数据将被原始平台的数据所覆盖。
请确认当前平台是你的目标平台，并在 5 分钟内使用你的账号在原始平台内向机器人发送以下文本：
/bind nonebot/123456
绑定完成后，你可以随时使用「bind -r」来解除绑定状态。
```
## 插件适配
先在插件代码最前面声明依赖
```python
from nonebot import require
require("nonebot_plugin_user")
```
获取用户信息
```python
from nonebot_plugin_user import User
@matcher.handle()
async def _(user: User):
await matcher.finish(user.id)
```
获取用户会话信息
```python
from nonebot_plugin_user import UserSession
@matcher.handle()
async def _(session: UserSession):
await matcher.finish(session.user_id)
```
## 配置项
配置方式：直接在 `NoneBot` 全局配置文件中添加以下配置项即可。
### user_token_prefix
- 类型: `str`
- 默认: `nonebot/`
- 说明: 生成令牌的前缀
## 计划
- [ ] 支持权限
## 鸣谢
- [Koishi](https://github.com/koishijs/koishi): 本项目直接参考
- [nonebot-plugin-session](https://github.com/noneplugin/nonebot-plugin-session): 获取用户信息
Raw data
{
"_id": null,
"home_page": "https://github.com/he0119/nonebot-plugin-user",
"name": "nonebot-plugin-user",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "hemengyang",
"author_email": "hmy0119@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6e/fc/0038d6b13799a36323cc5d7bf1131d02e05e473532af1cddbc819810e71b/nonebot_plugin_user-0.2.0.tar.gz",
"platform": null,
"description": "<!-- markdownlint-disable MD033 MD036 MD041 -->\n\n<p align=\"center\">\n <a href=\"https://v2.nonebot.dev/\"><img src=\"https://v2.nonebot.dev/logo.png\" width=\"200\" height=\"200\" alt=\"nonebot\"></a>\n</p>\n\n<div align=\"center\">\n\n# NoneBot Plugin User\n\n_\u2728 NoneBot \u7528\u6237\u63d2\u4ef6 \u2728_\n\n</div>\n\n<p align=\"center\">\n <a href=\"https://raw.githubusercontent.com/he0119/nonebot-plugin-user/main/LICENSE\">\n <img src=\"https://img.shields.io/github/license/he0119/nonebot-plugin-user.svg\" alt=\"license\">\n </a>\n <a href=\"https://pypi.python.org/pypi/nonebot-plugin-user\">\n <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-user.svg\" alt=\"pypi\">\n </a>\n <img src=\"https://img.shields.io/badge/python-3.8+-blue.svg\" alt=\"python\">\n <a href=\"https://codecov.io/gh/he0119/nonebot-plugin-user\">\n <img src=\"https://codecov.io/gh/he0119/nonebot-plugin-user/branch/main/graph/badge.svg?token=jd5ufc1alv\"/>\n </a>\n <a href=\"https://jq.qq.com/?_wv=1027&k=7zQUpiGp\">\n <img src=\"https://img.shields.io/badge/QQ%E7%BE%A4-730374631-orange?style=flat-square\" alt=\"QQ Chat Group\">\n </a>\n</p>\n\n## \u7b80\u4ecb\n\n## \u4f7f\u7528\u65b9\u5f0f\n\n\u52a0\u8f7d\u63d2\u4ef6\u540e\u53d1\u9001 `/user`\u3001`/inspect` \u6216 `/bind`\u3002\n\n### \u67e5\u770b\u7528\u6237\u4fe1\u606f\n\n\u901a\u8fc7 user \u547d\u4ee4\u53ef\u67e5\u770b\u7528\u6237\u4fe1\u606f:\n\n```text\n\u5e73\u53f0\u540d\uff1aqq\n\u5e73\u53f0 ID\uff1a10000\n\u7528\u6237\u540d\uff1auy/sun\n\u521b\u5efa\u65e5\u671f\uff1a2023-11-02 04:52:42\n```\n\n### \u67e5\u770b\u4f1a\u8bdd\u4fe1\u606f\n\n\u901a\u8fc7 inspect \u547d\u4ee4\u53ef\u67e5\u770b\u5f53\u524d\u4f1a\u8bdd\u4fe1\u606f:\n\n```text\n\u5e73\u53f0\u540d\uff1aqq\n\u5e73\u53f0 ID\uff1a10000\n\u81ea\u8eab ID\uff1a20000\n\u7fa4\u7ec4 ID\uff1a30000\n```\n\n### \u7ed1\u5b9a\u7528\u6237\n\n\u901a\u8fc7 bind \u547d\u4ee4\u53ef\u5c06\u4e0d\u540c\u7528\u6237\u7684\u6570\u636e\u7ed1\u5b9a:\n\n```text\n\u547d\u4ee4 bind \u53ef\u7528\u4e8e\u5728\u591a\u4e2a\u5e73\u53f0\u95f4\u7ed1\u5b9a\u7528\u6237\u6570\u636e\u3002\u7ed1\u5b9a\u8fc7\u7a0b\u4e2d\uff0c\u539f\u59cb\u5e73\u53f0\u7684\u7528\u6237\u6570\u636e\u5c06\u5b8c\u5168\u4fdd\u7559\uff0c\u800c\u76ee\u6807\u5e73\u53f0\u7684\u7528\u6237\u6570\u636e\u5c06\u88ab\u539f\u59cb\u5e73\u53f0\u7684\u6570\u636e\u6240\u8986\u76d6\u3002\n\u8bf7\u786e\u8ba4\u5f53\u524d\u5e73\u53f0\u662f\u4f60\u7684\u76ee\u6807\u5e73\u53f0\uff0c\u5e76\u5728 5 \u5206\u949f\u5185\u4f7f\u7528\u4f60\u7684\u8d26\u53f7\u5728\u539f\u59cb\u5e73\u53f0\u5185\u5411\u673a\u5668\u4eba\u53d1\u9001\u4ee5\u4e0b\u6587\u672c\uff1a\n/bind nonebot/123456\n\u7ed1\u5b9a\u5b8c\u6210\u540e\uff0c\u4f60\u53ef\u4ee5\u968f\u65f6\u4f7f\u7528\u300cbind -r\u300d\u6765\u89e3\u9664\u7ed1\u5b9a\u72b6\u6001\u3002\n```\n\n## \u63d2\u4ef6\u9002\u914d\n\n\u5148\u5728\u63d2\u4ef6\u4ee3\u7801\u6700\u524d\u9762\u58f0\u660e\u4f9d\u8d56\n\n```python\nfrom nonebot import require\nrequire(\"nonebot_plugin_user\")\n```\n\n\u83b7\u53d6\u7528\u6237\u4fe1\u606f\n\n```python\nfrom nonebot_plugin_user import User\n\n@matcher.handle()\nasync def _(user: User):\n await matcher.finish(user.id)\n```\n\n\u83b7\u53d6\u7528\u6237\u4f1a\u8bdd\u4fe1\u606f\n\n```python\nfrom nonebot_plugin_user import UserSession\n\n@matcher.handle()\nasync def _(session: UserSession):\n await matcher.finish(session.user_id)\n```\n\n## \u914d\u7f6e\u9879\n\n\u914d\u7f6e\u65b9\u5f0f\uff1a\u76f4\u63a5\u5728 `NoneBot` \u5168\u5c40\u914d\u7f6e\u6587\u4ef6\u4e2d\u6dfb\u52a0\u4ee5\u4e0b\u914d\u7f6e\u9879\u5373\u53ef\u3002\n\n### user_token_prefix\n\n- \u7c7b\u578b: `str`\n- \u9ed8\u8ba4: `nonebot/`\n- \u8bf4\u660e: \u751f\u6210\u4ee4\u724c\u7684\u524d\u7f00\n\n## \u8ba1\u5212\n\n- [ ] \u652f\u6301\u6743\u9650\n\n## \u9e23\u8c22\n\n- [Koishi](https://github.com/koishijs/koishi): \u672c\u9879\u76ee\u76f4\u63a5\u53c2\u8003\n- [nonebot-plugin-session](https://github.com/noneplugin/nonebot-plugin-session): \u83b7\u53d6\u7528\u6237\u4fe1\u606f\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\u9002\u7528\u4e8e Nonebot2 \u7684\u7528\u6237\u63d2\u4ef6",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/he0119/nonebot-plugin-user#readme",
"Homepage": "https://github.com/he0119/nonebot-plugin-user",
"Repository": "https://github.com/he0119/nonebot-plugin-user"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0c64b3253d8d7b16783c72bb689fbd2cdb37ee95dd663aeaa636f03c3f3c059",
"md5": "cf1255880bf1d3f9e99e712631171a90",
"sha256": "9b052551b13fd8f8fab39023a8088637b0447b0ef42d87f54a0e7e2c3c371740"
},
"downloads": -1,
"filename": "nonebot_plugin_user-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf1255880bf1d3f9e99e712631171a90",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 11532,
"upload_time": "2024-02-24T10:06:57",
"upload_time_iso_8601": "2024-02-24T10:06:57.539672Z",
"url": "https://files.pythonhosted.org/packages/f0/c6/4b3253d8d7b16783c72bb689fbd2cdb37ee95dd663aeaa636f03c3f3c059/nonebot_plugin_user-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6efc0038d6b13799a36323cc5d7bf1131d02e05e473532af1cddbc819810e71b",
"md5": "0ad0483ebd2e888a4913dfe6b0d98098",
"sha256": "f2f559e3381deb20a067fb2004a92f3625b1777da076ecfb956e334bdbe0f7d5"
},
"downloads": -1,
"filename": "nonebot_plugin_user-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "0ad0483ebd2e888a4913dfe6b0d98098",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 9313,
"upload_time": "2024-02-24T10:06:59",
"upload_time_iso_8601": "2024-02-24T10:06:59.319390Z",
"url": "https://files.pythonhosted.org/packages/6e/fc/0038d6b13799a36323cc5d7bf1131d02e05e473532af1cddbc819810e71b/nonebot_plugin_user-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-24 10:06:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "he0119",
"github_project": "nonebot-plugin-user",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nonebot-plugin-user"
}
JSON
