push-tools 0.0.1__tar.gz

push_tools-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 __SCRIPT__
+
+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.

push_tools-0.0.1/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: push-tools
+Version: 0.0.1
+Summary: A tool supports push message.
+Home-page: https://github.com/arcturus-script/push-tools
+Author: ARCTURUS
+Author-email: ice99125@qq.com
+License: MIT Licence
+Keywords: qmsg,pushplus,server,wechat
+Platform: any
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+
+# push-tools
+
+A repository for message push (๑•̀ㅂ•́)و✧
+
+## usage
+
+```python
+from push_tools import pushplus
+
+p = pushplus("069ac...")
+p.send("hello world.", title="test")
+```
+
+```python
+from push_tools import qmsg
+
+q = qmsg("5004...")
+q.send("hello world.")
+```
+
+```python
+from push_tools import server
+
+s = server("SCT8...")
+s.send("###title\nhello world.", title="title")
+```
+
+```python
+from push_tools import workWechat
+
+w = workWechat({
+    "corpSecret": "slFn...",
+    "corpid": "ww9f...",
+})
+
+w.send("###title3\nhello world.", msgtype="markdown")
+```
+
+```python
+from push_tools import workWechatRobot
+
+robot = workWechatRobot("ea3f7ac4..")
+robot.send("###title3\nhello world.", msgtype="markdown")
+```
+
+```python
+from push import push_composite, pushplus, qmsg
+
+p = PushComposite()
+p.add("pushplus", pushplus("069ac..."))
+p.add("qmsg", qmsg("5004..."))
+
+p.send("title\nhello world.", title="title")
+```
+
+```python
+from push import push_creator
+
+p = push_creator("qmsg", "2130...")
+p.send("hello world")
+```

push_tools-0.0.1/README.md

@@ -0,0 +1,61 @@
+# push-tools
+
+A repository for message push (๑•̀ㅂ•́)و✧
+
+## usage
+
+```python
+from push_tools import pushplus
+
+p = pushplus("069ac...")
+p.send("hello world.", title="test")
+```
+
+```python
+from push_tools import qmsg
+
+q = qmsg("5004...")
+q.send("hello world.")
+```
+
+```python
+from push_tools import server
+
+s = server("SCT8...")
+s.send("###title\nhello world.", title="title")
+```
+
+```python
+from push_tools import workWechat
+
+w = workWechat({
+    "corpSecret": "slFn...",
+    "corpid": "ww9f...",
+})
+
+w.send("###title3\nhello world.", msgtype="markdown")
+```
+
+```python
+from push_tools import workWechatRobot
+
+robot = workWechatRobot("ea3f7ac4..")
+robot.send("###title3\nhello world.", msgtype="markdown")
+```
+
+```python
+from push import push_composite, pushplus, qmsg
+
+p = PushComposite()
+p.add("pushplus", pushplus("069ac..."))
+p.add("qmsg", qmsg("5004..."))
+
+p.send("title\nhello world.", title="title")
+```
+
+```python
+from push import push_creator
+
+p = push_creator("qmsg", "2130...")
+p.send("hello world")
+```

push_tools-0.0.1/push_tools/__init__.py

@@ -0,0 +1,45 @@
+from .pushplus import pushplus
+from .qmsg import qmsg
+from .server import server
+from .wechat import workWechat, workWechatRobot
+
+push_server = {
+    "pushplus": pushplus,
+    "server": server,
+    "qmsg": qmsg,
+    "workWechatRobot": workWechatRobot,
+    "workWechat": workWechat,
+}
+
+
+class push_composite:
+    def __init__(self):
+        self.children = {}
+
+    def add(self, key, push):
+        self.children[key] = push
+
+    def send(self, msg, **kwargs):
+        for push in self.children.values():
+            push.send(msg, **kwargs)
+
+    def remove(self, key):
+        self.children.pop(key)
+
+
+class push_creator:
+    def __init__(self, type, key):
+        self.push = self.create(type, key)
+
+    def create(self, type, key):
+        if type not in push_server:
+            print(f"Unsupported push type: {type}")
+            return None
+
+        return push_server[type](key)
+
+    def send(self, msg, **kwargs):
+        if self.push is not None:
+            self.push.send(msg, **kwargs)
+        else:
+            print("No push instance created.")

push_tools-0.0.1/push_tools/err.py

@@ -0,0 +1,15 @@
+def catch_exception(func):
+    def wrapper(*args, **kwargs):
+        try:
+            return func(*args, **kwargs)
+        except Exception as e:
+            name = args[0].__class__.__name__
+            err_type = type(e).__name__
+
+            print(f"[{name}] An error occurred, because > {err_type}: {e}")
+
+    return wrapper
+
+
+class AccessFailed(Exception):
+    pass

push_tools-0.0.1/push_tools/push.py

@@ -0,0 +1,19 @@
+from abc import ABC, abstractmethod
+
+
+class push(ABC):
+    def __init__(self, key):
+        super().__init__()
+        self.key = key
+
+    @abstractmethod
+    def send(self, msg, **kwargs):
+        pass
+
+    def success(self, *args):
+        name = self.__class__.__name__
+
+        if args:
+            print(f"[{name}]", *args)
+        else:
+            print(f"[{name}] Operate successfully.")

push_tools-0.0.1/push_tools/pushplus.py

@@ -0,0 +1,44 @@
+from .err import catch_exception, AccessFailed
+from .push import push
+import requests as re
+
+
+# https://www.pushplus.plus
+class pushplus(push):
+    # 请求地址
+    url = "http://www.pushplus.plus/send"
+
+    def __init__(self, key):
+        super().__init__(key)
+
+    # 消息接口
+    @catch_exception
+    def send(self, msg, **kwargs):
+        params = {
+            "token": self.key,
+            "content": msg,
+        }
+
+        # 请求参数
+        options = [
+            "title",
+            "topic",
+            "template",
+            "channel",
+            "webhook",
+            "callbackUrl",
+            "timestamp",
+            "to",
+            "pre",
+        ]
+
+        for key, value in kwargs.items():
+            if key in options:
+                params[key] = value
+
+        res = re.post(self.url, json=params).json()
+
+        if res.get("code") == 200:
+            self.success()
+        else:
+            raise AccessFailed(res.get("msg"))

push_tools-0.0.1/push_tools/qmsg.py

@@ -0,0 +1,28 @@
+from .err import catch_exception, AccessFailed
+from .push import push
+import requests as re
+
+
+# https://qmsg.zendee.cn/
+class qmsg(push):
+    url = "https://qmsg.zendee.cn"
+
+    def __init__(self, key):
+        super().__init__(key)
+        self.url = f"{qmsg.url}/send/{key}"
+
+    @catch_exception
+    def send(self, msg, **kwargs) -> None:
+        params = {"msg": msg}
+        options = ["qq", "bot"]
+
+        for k, v in kwargs.items():
+            if k in options:
+                params[k] = v
+
+        res = re.post(self.url, params=params).json()
+
+        if res.get("code") == 0:
+            self.success()
+        else:
+            raise AccessFailed(res.get("reason"))

push_tools-0.0.1/push_tools/server.py

@@ -0,0 +1,28 @@
+from .err import catch_exception, AccessFailed
+from .push import push
+import requests as re
+
+
+# https://sct.ftqq.com
+class server(push):
+    url = "https://sctapi.ftqq.com"
+
+    def __init__(self, key):
+        super().__init__(key)
+        self.url = f"{server.url}/{self.key}.send"
+
+    @catch_exception
+    def send(self, msg, title, **kwargs):
+        params = {"title": title, "desp": msg}
+        options = ["short", "noip", "channel", "openid"]
+
+        for k, v in kwargs.items():
+            if k in options:
+                params[k] = v
+
+        res = re.post(self.url, params=params).json()
+
+        if res.get("code") == 0:
+            self.success()
+        else:
+            raise AccessFailed(res.get("info"))

push_tools-0.0.1/push_tools/wechat.py

@@ -0,0 +1,124 @@
+from .err import catch_exception, AccessFailed
+from .push import push
+import requests as re
+
+
+# 内部应用开发文档 (https://developer.work.weixin.qq.com/document/path/90664)
+# 相关参数获取方法 (https://developer.work.weixin.qq.com/document/path/90665)
+class workWechat(push):
+    token = "https://qyapi.weixin.qq.com/cgi-bin/gettoken"
+    url = "https://qyapi.weixin.qq.com/cgi-bin/message/send"
+
+    def __init__(self, key):
+        super().__init__(key)
+
+    @catch_exception
+    def get_access_token(self):
+        corpSecret = self.key["corpSecret"]
+        corid = self.key["corpid"]
+
+        params = {"corpid": corid, "corpsecret": corpSecret}
+
+        res = re.get(self.token, params).json()
+
+        if res.get("errcode") == 0:
+            return res.get("access_token")
+        else:
+            raise AccessFailed(res.get("errmsg"))
+
+    # 文本消息
+    def send(self, msg, agentid, **kwargs):
+        msgtype = kwargs.get("msgtype", "text")
+
+        body = {"msgtype": msgtype, msgtype: {"content": msg}, "agentid": agentid}
+
+        options = {
+            "touser": "@all",
+            "toparty": "",
+            "totag": "",
+            "safe": 0,
+            "enable_id_trans": 0,
+            "enable_duplicate_check": 0,
+            "duplicate_check_interval": 1800,
+        }
+
+        for k, v in options.items():
+            if k in kwargs:
+                body[k] = v
+            else:
+                body[k] = options[k]
+
+        self.raw_send(body)
+
+    @catch_exception
+    def raw_send(self, body):
+        params = {"access_token": self.get_access_token()}
+
+        res = re.post(self.url, params=params, json=body).json()
+
+        errcode = res.get("errcode")
+
+        if errcode == 0:
+            self.success()
+        else:
+            raise AccessFailed(res.get("errmsg"))
+
+
+# https://developer.work.weixin.qq.com/document/path/91770
+class workWechatRobot(push):
+    url = "https://qyapi.weixin.qq.com/cgi-bin/webhook"
+
+    def __init__(self, key):
+        super().__init__(key)
+        self.surl = f"{workWechatRobot.url}/send"
+        self.uurl = f"{workWechatRobot.url}/upload_media"
+
+    def send(self, msg, **kwargs):
+        msgtype = kwargs.get("msgtype")
+
+        if msgtype == "markdown":
+            self._markdown(msg)
+        else:
+            self._text(msg, **kwargs)
+
+    @catch_exception
+    def raw_send(self, body):
+        res = re.post(self.surl, params={"key": self.key}, json=body).json()
+
+        errcode = res.get("errcode")
+
+        if errcode == 0:
+            self.success()
+        else:
+            raise AccessFailed(res.get("errmsg"))
+
+    def _text(self, content, **kwargs):
+        options = ["mentioned_list", "mentioned_mobile_list"]
+        body = {"content": content}
+
+        for k, v in kwargs.items():
+            if k in options:
+                body[k] = v
+
+        self.raw_send({"msgtype": "text", "text": body})
+
+    def _markdown(self, content):
+        self.raw_send({"msgtype": "markdown", "markdown": {"content": content}})
+
+    @catch_exception
+    def upload(self, type, file):
+        res = re.post(
+            self.uurl,
+            params={
+                "key": self.key,
+                "type": type,
+            },
+            files={"file": file},
+        ).json()
+
+        errcode = res.get("errcode")
+
+        if errcode == 0:
+            return res.get("media_id")
+        else:
+            raise AccessFailed(res.get("errmsg"))

push_tools-0.0.1/push_tools.egg-info/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.1
+Name: push-tools
+Version: 0.0.1
+Summary: A tool supports push message.
+Home-page: https://github.com/arcturus-script/push-tools
+Author: ARCTURUS
+Author-email: ice99125@qq.com
+License: MIT Licence
+Keywords: qmsg,pushplus,server,wechat
+Platform: any
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+
+# push-tools
+
+A repository for message push (๑•̀ㅂ•́)و✧
+
+## usage
+
+```python
+from push_tools import pushplus
+
+p = pushplus("069ac...")
+p.send("hello world.", title="test")
+```
+
+```python
+from push_tools import qmsg
+
+q = qmsg("5004...")
+q.send("hello world.")
+```
+
+```python
+from push_tools import server
+
+s = server("SCT8...")
+s.send("###title\nhello world.", title="title")
+```
+
+```python
+from push_tools import workWechat
+
+w = workWechat({
+    "corpSecret": "slFn...",
+    "corpid": "ww9f...",
+})
+
+w.send("###title3\nhello world.", msgtype="markdown")
+```
+
+```python
+from push_tools import workWechatRobot
+
+robot = workWechatRobot("ea3f7ac4..")
+robot.send("###title3\nhello world.", msgtype="markdown")
+```
+
+```python
+from push import push_composite, pushplus, qmsg
+
+p = PushComposite()
+p.add("pushplus", pushplus("069ac..."))
+p.add("qmsg", qmsg("5004..."))
+
+p.send("title\nhello world.", title="title")
+```
+
+```python
+from push import push_creator
+
+p = push_creator("qmsg", "2130...")
+p.send("hello world")
+```

push_tools-0.0.1/push_tools.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+setup.py
+push_tools/__init__.py
+push_tools/err.py
+push_tools/push.py
+push_tools/pushplus.py
+push_tools/qmsg.py
+push_tools/server.py
+push_tools/wechat.py
+push_tools.egg-info/PKG-INFO
+push_tools.egg-info/SOURCES.txt
+push_tools.egg-info/dependency_links.txt
+push_tools.egg-info/requires.txt
+push_tools.egg-info/top_level.txt

push_tools-0.0.1/push_tools.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

push_tools-0.0.1/push_tools.egg-info/requires.txt

@@ -0,0 +1 @@
+requests

push_tools-0.0.1/push_tools.egg-info/top_level.txt

@@ -0,0 +1 @@
+push_tools

push_tools-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

push_tools-0.0.1/setup.py

@@ -0,0 +1,18 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="push-tools",
+    version="0.0.1",
+    keywords=["qmsg", "pushplus", "server", "wechat"],
+    description="A tool supports push message.",
+    long_description=open("README.md", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
+    license="MIT Licence",
+    url="https://github.com/arcturus-script/push-tools",
+    author="ARCTURUS",
+    author_email="ice99125@qq.com",
+    packages=find_packages(),
+    include_package_data=True,
+    platforms="any",
+    install_requires=["requests"],
+)