nonebot-plugin-gotify


Namenonebot-plugin-gotify JSON
Version 1.0.9 PyPI version JSON
download
home_pageNone
SummaryDefault template for PDM package
upload_time2024-10-20 14:17:58
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
  <img src="https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png" width="180" height="180" alt="NoneBotPluginLogo">

</div>

<div align="center">

# nonebot-plugin-gotify

_✨ 将NoneBot的通知和讯息推送到[Gotify](https://gotify.net/) ✨_

_✨ Push NoneBot's notifications and messages to [Gotify](https://gotify.net/) ✨_


<a href="./LICENSE">
    <img src="https://img.shields.io/github/license/snowykami/nonebot-plugin-gotify.svg" alt="license">
</a>
<a href="https://pypi.python.org/pypi/nonebot-plugin-gotify">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-gotify.svg" alt="pypi">
</a>
<img src="https://img.shields.io/badge/python-3.10+-blue.svg" alt="python">

</div>

## 📖 介绍 Introduction

将Bot生命周期,聊天讯息实时推送到[Gotify](https://gotify.net/),实现个人通知管理器

Push Bot lifecycle and chat messages to [Gotify](https://gotify.net/) in real time, and achieve personal notification manager

## 💿 安装 Installation

<details open>
<summary>使用 nb-cli 安装(推荐,需先安装`nb-cli`)  Use nb-cli</summary>

    nb plugin install nonebot-plugin-gotify

</details>

<details open>
<summary>使用 pip 安装 Use pip</summary>

    pip install nonebot-plugin-gotify

</details>

<details>
<summary>使用包管理器安装 Use other package manager</summary>
在 nonebot2 项目的插件目录下, 打开命令行, 根据你使用的包管理器, 输入相应的安装命令

<details>
<summary>pip</summary>

    pip install nonebot-plugin-gotify

</details>
<details>
<summary>pdm</summary>

    pdm add nonebot-plugin-gotify

</details>
<details>
<summary>poetry</summary>

    poetry add nonebot-plugin-gotify

</details>
<dstetails>
<summary>conda</summary>

    conda install nonebot-plugin-gotify

</dstetails>
</details>

轻雪机器人已内置该插件,无需单独安装

LiteyukiBot has built-in this plugin, no need to install separately

## 🎉 使用 Usage

本插件暂时没有和用户交互的部分

This plugin does not have an interactive part with the user for the time being

## ⚙️ 配置 Configuration

```python
# 必要字段 Required
GOTIFY_URL = "http://your-gotify-server:port"
GOTIFY_TOKEN = "your-gotify-token"
# 可选字段 Optional with default value
GOTIFY_PRIORITY = 5
GOTIFY_NICKNAME = "NoneBot" # 推送系统消息的昵称 Nickname for system messages
GOTIFY_TITLE = "{message_type}: {nickname}({user_id})" # 推送系统消息的标题模板 Title for system messages template
GOTIFY_MESSAGE = "{message}" # 推送系统消息的内容模板 Content for system messages template
GOTIFY_INCLUDES = ["message", "notice"] # 包含的消息类型 Includes message types
```

目前支持的占位符 Currently supported placeholders:
- `{message_type}`: 消息类型 Message type
- `{nickname}`: 昵称 Nickname
- `{user_id}`: 用户ID User ID
- `{message}`: 消息内容 Message content

## ℹ️ 其他 Other

- 目前该插件已内置在[轻雪机器人应用](https://bot.liteyuki.icu)中,无需单独安装.
The plugin has been built into the [LiteyukiBot application](https://bot.liteyuki.icu), no need to install separately

- 该插件仍然有许多内容需要完善,欢迎各位的建议及贡献.
There are still many things to be improved in this plugin, welcome your suggestions and contributions
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nonebot-plugin-gotify",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "snowykami <snowykami@outlook.com>",
    "download_url": "https://files.pythonhosted.org/packages/0a/67/6227d3e318a96c0173508c2445047fe790b480530499fa9cd18c729b0559/nonebot_plugin_gotify-1.0.9.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n  <img src=\"https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png\" width=\"180\" height=\"180\" alt=\"NoneBotPluginLogo\">\n\n</div>\n\n<div align=\"center\">\n\n# nonebot-plugin-gotify\n\n_\u2728 \u5c06NoneBot\u7684\u901a\u77e5\u548c\u8baf\u606f\u63a8\u9001\u5230[Gotify](https://gotify.net/) \u2728_\n\n_\u2728 Push NoneBot's notifications and messages to [Gotify](https://gotify.net/) \u2728_\n\n\n<a href=\"./LICENSE\">\n    <img src=\"https://img.shields.io/github/license/snowykami/nonebot-plugin-gotify.svg\" alt=\"license\">\n</a>\n<a href=\"https://pypi.python.org/pypi/nonebot-plugin-gotify\">\n    <img src=\"https://img.shields.io/pypi/v/nonebot-plugin-gotify.svg\" alt=\"pypi\">\n</a>\n<img src=\"https://img.shields.io/badge/python-3.10+-blue.svg\" alt=\"python\">\n\n</div>\n\n## \ud83d\udcd6 \u4ecb\u7ecd Introduction\n\n\u5c06Bot\u751f\u547d\u5468\u671f\uff0c\u804a\u5929\u8baf\u606f\u5b9e\u65f6\u63a8\u9001\u5230[Gotify](https://gotify.net/)\uff0c\u5b9e\u73b0\u4e2a\u4eba\u901a\u77e5\u7ba1\u7406\u5668\n\nPush Bot lifecycle and chat messages to [Gotify](https://gotify.net/) in real time, and achieve personal notification manager\n\n## \ud83d\udcbf \u5b89\u88c5 Installation\n\n<details open>\n<summary>\u4f7f\u7528 nb-cli \u5b89\u88c5(\u63a8\u8350\uff0c\u9700\u5148\u5b89\u88c5`nb-cli`)  Use nb-cli</summary>\n\n    nb plugin install nonebot-plugin-gotify\n\n</details>\n\n<details open>\n<summary>\u4f7f\u7528 pip \u5b89\u88c5 Use pip</summary>\n\n    pip install nonebot-plugin-gotify\n\n</details>\n\n<details>\n<summary>\u4f7f\u7528\u5305\u7ba1\u7406\u5668\u5b89\u88c5 Use other package manager</summary>\n\u5728 nonebot2 \u9879\u76ee\u7684\u63d2\u4ef6\u76ee\u5f55\u4e0b, \u6253\u5f00\u547d\u4ee4\u884c, \u6839\u636e\u4f60\u4f7f\u7528\u7684\u5305\u7ba1\u7406\u5668, \u8f93\u5165\u76f8\u5e94\u7684\u5b89\u88c5\u547d\u4ee4\n\n<details>\n<summary>pip</summary>\n\n    pip install nonebot-plugin-gotify\n\n</details>\n<details>\n<summary>pdm</summary>\n\n    pdm add nonebot-plugin-gotify\n\n</details>\n<details>\n<summary>poetry</summary>\n\n    poetry add nonebot-plugin-gotify\n\n</details>\n<dstetails>\n<summary>conda</summary>\n\n    conda install nonebot-plugin-gotify\n\n</dstetails>\n</details>\n\n\u8f7b\u96ea\u673a\u5668\u4eba\u5df2\u5185\u7f6e\u8be5\u63d2\u4ef6\uff0c\u65e0\u9700\u5355\u72ec\u5b89\u88c5\n\nLiteyukiBot has built-in this plugin, no need to install separately\n\n## \ud83c\udf89 \u4f7f\u7528 Usage\n\n\u672c\u63d2\u4ef6\u6682\u65f6\u6ca1\u6709\u548c\u7528\u6237\u4ea4\u4e92\u7684\u90e8\u5206\n\nThis plugin does not have an interactive part with the user for the time being\n\n## \u2699\ufe0f \u914d\u7f6e Configuration\n\n```python\n# \u5fc5\u8981\u5b57\u6bb5 Required\nGOTIFY_URL = \"http://your-gotify-server:port\"\nGOTIFY_TOKEN = \"your-gotify-token\"\n# \u53ef\u9009\u5b57\u6bb5 Optional with default value\nGOTIFY_PRIORITY = 5\nGOTIFY_NICKNAME = \"NoneBot\" # \u63a8\u9001\u7cfb\u7edf\u6d88\u606f\u7684\u6635\u79f0 Nickname for system messages\nGOTIFY_TITLE = \"{message_type}: {nickname}({user_id})\" # \u63a8\u9001\u7cfb\u7edf\u6d88\u606f\u7684\u6807\u9898\u6a21\u677f Title for system messages template\nGOTIFY_MESSAGE = \"{message}\" # \u63a8\u9001\u7cfb\u7edf\u6d88\u606f\u7684\u5185\u5bb9\u6a21\u677f Content for system messages template\nGOTIFY_INCLUDES = [\"message\", \"notice\"] # \u5305\u542b\u7684\u6d88\u606f\u7c7b\u578b Includes message types\n```\n\n\u76ee\u524d\u652f\u6301\u7684\u5360\u4f4d\u7b26 Currently supported placeholders:\n- `{message_type}`: \u6d88\u606f\u7c7b\u578b Message type\n- `{nickname}`: \u6635\u79f0 Nickname\n- `{user_id}`: \u7528\u6237ID User ID\n- `{message}`: \u6d88\u606f\u5185\u5bb9 Message content\n\n## \u2139\ufe0f \u5176\u4ed6 Other\n\n- \u76ee\u524d\u8be5\u63d2\u4ef6\u5df2\u5185\u7f6e\u5728[\u8f7b\u96ea\u673a\u5668\u4eba\u5e94\u7528](https://bot.liteyuki.icu)\u4e2d\uff0c\u65e0\u9700\u5355\u72ec\u5b89\u88c5.\nThe plugin has been built into the [LiteyukiBot application](https://bot.liteyuki.icu), no need to install separately\n\n- \u8be5\u63d2\u4ef6\u4ecd\u7136\u6709\u8bb8\u591a\u5185\u5bb9\u9700\u8981\u5b8c\u5584\uff0c\u6b22\u8fce\u5404\u4f4d\u7684\u5efa\u8bae\u53ca\u8d21\u732e.\nThere are still many things to be improved in this plugin, welcome your suggestions and contributions",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Default template for PDM package",
    "version": "1.0.9",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bea84cff0dd1b0d647396cd88cf8dd3760c7c766f8c5a3cd3c89c4c98b2f7d3f",
                "md5": "0b8e2a7b4db573d46c74cd990636aa21",
                "sha256": "072c051b572249f28acf75d6a1779173e44d2cafa7574bec8a76771d2e3d914d"
            },
            "downloads": -1,
            "filename": "nonebot_plugin_gotify-1.0.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0b8e2a7b4db573d46c74cd990636aa21",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 6135,
            "upload_time": "2024-10-20T14:17:57",
            "upload_time_iso_8601": "2024-10-20T14:17:57.674550Z",
            "url": "https://files.pythonhosted.org/packages/be/a8/4cff0dd1b0d647396cd88cf8dd3760c7c766f8c5a3cd3c89c4c98b2f7d3f/nonebot_plugin_gotify-1.0.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a676227d3e318a96c0173508c2445047fe790b480530499fa9cd18c729b0559",
                "md5": "a504a8081fc0c22d3923f5a766f9af55",
                "sha256": "5432910569bd2f5703022e574ccfd1def4a4c389eb66ff3e8497b25b077c252e"
            },
            "downloads": -1,
            "filename": "nonebot_plugin_gotify-1.0.9.tar.gz",
            "has_sig": false,
            "md5_digest": "a504a8081fc0c22d3923f5a766f9af55",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 4638,
            "upload_time": "2024-10-20T14:17:58",
            "upload_time_iso_8601": "2024-10-20T14:17:58.536599Z",
            "url": "https://files.pythonhosted.org/packages/0a/67/6227d3e318a96c0173508c2445047fe790b480530499fa9cd18c729b0559/nonebot_plugin_gotify-1.0.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-20 14:17:58",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "nonebot-plugin-gotify"
}
        
Elapsed time: 1.20814s