# ipush
向 APP、微信平台推送通知。
支持往 **Telegram、钉钉群、飞书群、Lark 群、Bark、Chanify、PushDeer、PushPlus、Showdoc、息知、Alertzy、Notify** 推送消息。
<a href="https://pypi.org/project/ipush" target="_blank">
<img src="https://img.shields.io/pypi/v/ipush.svg" alt="Package version">
</a>
<a href="https://pypi.org/project/ipush" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/ipush.svg" alt="Supported Python versions">
</a>
---
## 使用说明
1. 安装依赖
```bash
pip install -U ipush
```
2. 创建 `notify` 对象,并发送消息
```python
from ipush import Dingtalk
notify = Dingtalk("token", "secret")
notify.send("iPush test")
```
## 支持平台
| 状态 | **国内**平台 | 官网 | 备注 |
| :------- | :------------------- | :--------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------- |
| ✔ **荐** | **钉钉群机器人** | [https://open.dingtalk.com/](https://open.dingtalk.com/document/robots/customize-robot-security-settings) |
| ✔ **荐** | **飞书群机器人** | [https://open.feishu.cn/](https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot) | |
| ✔ **荐** | **Lark 群机器人** | [https://open.larksuite.com/](https://open.larksuite.com/document/client-docs/bot-v3/add-custom-bot) | |
| ✔ **荐** | **Bark** | [https://day.app/2021/06/barkfaq/](https://day.app/2021/06/barkfaq/) | 仅支持 `iOS` |
| ✔ | **Chanify** | [https://www.chanify.net/](https://www.chanify.net/) | 仅支持 `iOS` |
| ✔ | **PushDeer** | https://www.pushdeer.com/ | |
| ✔ **荐** | **企业微信群机器人** | [https://developer.work.weixin.qq.com](https://developer.work.weixin.qq.com/document/path/91770?notreplace=true) | |
| // | // | **基于微信公众号** | \\\\ |
| ✔ | **PushPlus** | [https://www.pushplus.plus/](https://www.pushplus.plus/doc) | |
| ✔ | **Showdoc** | [https://push.showdoc.com.cn/](https://www.showdoc.com.cn/push) | |
| ✔ | **息知** | [https://xz.qqoq.net/](https://xz.qqoq.net/) | |
| ✔ | **聚合云推** | [https://tui.juhe.cn/](https://tui.juhe.cn/docs) | 聚合推送。支持 `邮箱`、`微信公众号`、`钉钉机器人`、`WebHook`、`企业微信`、`Bark` |
| 状态 | **国外**平台 | 官网 | 备注 |
| :------- | :----------- | :-------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |
| ✔ **荐** | **Telegram** | [https://core.telegram.org/bots/](https://core.telegram.org/bots/api#sendmessage) | 创建[Bot](https://t.me/BotFather)后,将 Bot 添加至群组或频道,再添加[获取 ChatId 的机器人进群组](https://t.me/getmyid_bot)(可移除),即可获得`ChatId` |
| ✔ | **Alertzy** | [https://alertzy.app/](https://alertzy.app/) | |
| ✔ | **Notify** | [https://notify.dev/](https://notify.dev/docs/quickstart) | 安装手机 APP,复制设备 ID(`Settings -> Device ID`),输入到 [`Playground`](https://notify.dev/playground),获取二维码,再使用手机 APP 扫描 |
## 开发
### 1. 前置开发环境
1. 使用 [**Rye**](https://rye-up.com/) 作为包管理工具
### 2. 开发流程
1. 安装依赖包:
```bash
# 同步
rye sync
```
2. 代码检测与格式化:
```bash
# 检测
rye run check
# 格式化
rye run format
```
3. 单元测试:
```bash
# rye test
rye run tests
# pytest
python -m pytest
# 打印测试报告
python -m pytest -s
```
## 仓库镜像
- https://git.jetsung.com/idev/pypush
- https://framagit.org/idev/pypush
- https://github.com/idevsig/pypush
Raw data
{
"_id": null,
"home_page": "",
"name": "ipush",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "bark,chanify,dingtalk,feishu,lark,notify,push,pushdeer,pushplus,showdoc,telegram,wechat,xizhi",
"author": "",
"author_email": "Jetsung Chan <jetsungchan@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/2b/fb/80b69a0eca0f87d99dd56df7d9fe5737839f59b63f440d42cd98cc0d0b66/ipush-0.6.0.tar.gz",
"platform": null,
"description": "# ipush\n\n\u5411 APP\u3001\u5fae\u4fe1\u5e73\u53f0\u63a8\u9001\u901a\u77e5\u3002\n\u652f\u6301\u5f80 **Telegram\u3001\u9489\u9489\u7fa4\u3001\u98de\u4e66\u7fa4\u3001Lark \u7fa4\u3001Bark\u3001Chanify\u3001PushDeer\u3001PushPlus\u3001Showdoc\u3001\u606f\u77e5\u3001Alertzy\u3001Notify** \u63a8\u9001\u6d88\u606f\u3002\n\n<a href=\"https://pypi.org/project/ipush\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/ipush.svg\" alt=\"Package version\">\n</a>\n\n<a href=\"https://pypi.org/project/ipush\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/pyversions/ipush.svg\" alt=\"Supported Python versions\">\n</a>\n\n---\n\n## \u4f7f\u7528\u8bf4\u660e\n\n1. \u5b89\u88c5\u4f9d\u8d56\n\n```bash\npip install -U ipush\n```\n\n2. \u521b\u5efa `notify` \u5bf9\u8c61\uff0c\u5e76\u53d1\u9001\u6d88\u606f\n\n```python\nfrom ipush import Dingtalk\n\nnotify = Dingtalk(\"token\", \"secret\")\nnotify.send(\"iPush test\")\n```\n\n## \u652f\u6301\u5e73\u53f0\n\n| \u72b6\u6001 | **\u56fd\u5185**\u5e73\u53f0 | \u5b98\u7f51 | \u5907\u6ce8 |\n| :------- | :------------------- | :--------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------- |\n| \u2714 **\u8350** | **\u9489\u9489\u7fa4\u673a\u5668\u4eba** | [https://open.dingtalk.com/](https://open.dingtalk.com/document/robots/customize-robot-security-settings) |\n| \u2714 **\u8350** | **\u98de\u4e66\u7fa4\u673a\u5668\u4eba** | [https://open.feishu.cn/](https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot) | |\n| \u2714 **\u8350** | **Lark \u7fa4\u673a\u5668\u4eba** | [https://open.larksuite.com/](https://open.larksuite.com/document/client-docs/bot-v3/add-custom-bot) | |\n| \u2714 **\u8350** | **Bark** | [https://day.app/2021/06/barkfaq/](https://day.app/2021/06/barkfaq/) | \u4ec5\u652f\u6301 `iOS` |\n| \u2714 | **Chanify** | [https://www.chanify.net/](https://www.chanify.net/) | \u4ec5\u652f\u6301 `iOS` |\n| \u2714 | **PushDeer** | https://www.pushdeer.com/ | |\n| \u2714 **\u8350** | **\u4f01\u4e1a\u5fae\u4fe1\u7fa4\u673a\u5668\u4eba** | [https://developer.work.weixin.qq.com](https://developer.work.weixin.qq.com/document/path/91770?notreplace=true) | |\n| // | // | **\u57fa\u4e8e\u5fae\u4fe1\u516c\u4f17\u53f7** | \\\\\\\\ |\n| \u2714 | **PushPlus** | [https://www.pushplus.plus/](https://www.pushplus.plus/doc) | |\n| \u2714 | **Showdoc** | [https://push.showdoc.com.cn/](https://www.showdoc.com.cn/push) | |\n| \u2714 | **\u606f\u77e5** | [https://xz.qqoq.net/](https://xz.qqoq.net/) | |\n| \u2714 | **\u805a\u5408\u4e91\u63a8** | [https://tui.juhe.cn/](https://tui.juhe.cn/docs) | \u805a\u5408\u63a8\u9001\u3002\u652f\u6301 `\u90ae\u7bb1`\u3001`\u5fae\u4fe1\u516c\u4f17\u53f7`\u3001`\u9489\u9489\u673a\u5668\u4eba`\u3001`WebHook`\u3001`\u4f01\u4e1a\u5fae\u4fe1`\u3001`Bark` |\n\n| \u72b6\u6001 | **\u56fd\u5916**\u5e73\u53f0 | \u5b98\u7f51 | \u5907\u6ce8 |\n| :------- | :----------- | :-------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |\n| \u2714 **\u8350** | **Telegram** | [https://core.telegram.org/bots/](https://core.telegram.org/bots/api#sendmessage) | \u521b\u5efa[Bot](https://t.me/BotFather)\u540e\uff0c\u5c06 Bot \u6dfb\u52a0\u81f3\u7fa4\u7ec4\u6216\u9891\u9053\uff0c\u518d\u6dfb\u52a0[\u83b7\u53d6 ChatId \u7684\u673a\u5668\u4eba\u8fdb\u7fa4\u7ec4](https://t.me/getmyid_bot)(\u53ef\u79fb\u9664)\uff0c\u5373\u53ef\u83b7\u5f97`ChatId` |\n| \u2714 | **Alertzy** | [https://alertzy.app/](https://alertzy.app/) | |\n| \u2714 | **Notify** | [https://notify.dev/](https://notify.dev/docs/quickstart) | \u5b89\u88c5\u624b\u673a APP\uff0c\u590d\u5236\u8bbe\u5907 ID\uff08`Settings -> Device ID`\uff09\uff0c\u8f93\u5165\u5230 [`Playground`](https://notify.dev/playground)\uff0c\u83b7\u53d6\u4e8c\u7ef4\u7801\uff0c\u518d\u4f7f\u7528\u624b\u673a APP \u626b\u63cf |\n\n## \u5f00\u53d1\n\n### 1. \u524d\u7f6e\u5f00\u53d1\u73af\u5883\n\n1. \u4f7f\u7528 [**Rye**](https://rye-up.com/) \u4f5c\u4e3a\u5305\u7ba1\u7406\u5de5\u5177\n\n### 2. \u5f00\u53d1\u6d41\u7a0b\n\n1. \u5b89\u88c5\u4f9d\u8d56\u5305\uff1a\n\n```bash\n# \u540c\u6b65\nrye sync\n```\n\n2. \u4ee3\u7801\u68c0\u6d4b\u4e0e\u683c\u5f0f\u5316\uff1a\n\n```bash\n# \u68c0\u6d4b\nrye run check\n\n# \u683c\u5f0f\u5316\nrye run format\n```\n\n3. \u5355\u5143\u6d4b\u8bd5\uff1a\n\n```bash\n# rye test\nrye run tests\n\n# pytest\npython -m pytest\n\n# \u6253\u5370\u6d4b\u8bd5\u62a5\u544a\npython -m pytest -s\n```\n\n## \u4ed3\u5e93\u955c\u50cf\n\n- https://git.jetsung.com/idev/pypush\n- https://framagit.org/idev/pypush\n- https://github.com/idevsig/pypush\n",
"bugtrack_url": null,
"license": "",
"summary": "\u5411 APP\u3001\u5fae\u4fe1\u5e73\u53f0\u63a8\u9001\u901a\u77e5\u3002\u652f\u6301 Telegram\u3001\u9489\u9489\u7fa4\u3001\u98de\u4e66\u7fa4\u3001\u4f01\u4e1a\u5fae\u4fe1\u7fa4\u3001Lark \u7fa4\u3001Bark \u7b49\u5e73\u53f0\u3002",
"version": "0.6.0",
"project_urls": {
"Documentation": "https://pypush.skiy.net/",
"Download": "https://github.com/idevsig/pypush/releases",
"Homepage": "https://git.jetsung.com/idev/pypush",
"Repository": "https://github.com/idevsig/pypush"
},
"split_keywords": [
"bark",
"chanify",
"dingtalk",
"feishu",
"lark",
"notify",
"push",
"pushdeer",
"pushplus",
"showdoc",
"telegram",
"wechat",
"xizhi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5515ea8a814b418ecc00ec5d978c1e2533288c870cf67a7dda3bac5e83e20089",
"md5": "b8ca83169ba15ec3eb46787eb9b1b8d6",
"sha256": "aad77abe9f77bbdbf6fe4817113bc3c6e1147e9152c5a71cda079a6865b5e5c5"
},
"downloads": -1,
"filename": "ipush-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8ca83169ba15ec3eb46787eb9b1b8d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 19798,
"upload_time": "2024-01-19T09:32:31",
"upload_time_iso_8601": "2024-01-19T09:32:31.030158Z",
"url": "https://files.pythonhosted.org/packages/55/15/ea8a814b418ecc00ec5d978c1e2533288c870cf67a7dda3bac5e83e20089/ipush-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2bfb80b69a0eca0f87d99dd56df7d9fe5737839f59b63f440d42cd98cc0d0b66",
"md5": "083c09a29119ab7de26b9bcac24051c8",
"sha256": "2a4a3f018a6e578843757145ef0849e90bebbf066139719ce8262cfc27e5ab3e"
},
"downloads": -1,
"filename": "ipush-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "083c09a29119ab7de26b9bcac24051c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17289,
"upload_time": "2024-01-19T09:32:33",
"upload_time_iso_8601": "2024-01-19T09:32:33.119489Z",
"url": "https://files.pythonhosted.org/packages/2b/fb/80b69a0eca0f87d99dd56df7d9fe5737839f59b63f440d42cd98cc0d0b66/ipush-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-19 09:32:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "idevsig",
"github_project": "pypush",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ipush"
}