Metadata-Version: 2.1
Name: WX-Push-Services
Version: 1.0.23
Summary: Push message to wechat
Home-page: https://github.com/IronManStank/QYWX_PushService
Author: Super.S
Author-email: 1157723200@qq.com
License: MIT License
Keywords: wechat,push,message,qywx,wxpusher
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
License-File: LICENSE
Requires-Dist: requests (==2.28.2)
Requires-Dist: retry (==0.9.2)


.. figure:: https://img.shields.io/pypi/pyversions/WX-Push-Services?style=plastic
   :alt: PyPI - Python Version

.. figure:: https://img.shields.io/pypi/dm/WX-Push-Services
   :alt: PyPI - Downloads

.. figure:: https://img.shields.io/pypi/status/WX-Push-Services
   :alt: PyPI - Status

.. figure:: https://img.shields.io/pypi/l/WX-Push-Services
   :alt: PyPI - License
   
.. figure:: https://img.shields.io/github/issues-search?query=WX-Push-Services
   :alt: GitHub issue custom search



重大更新
==========


目前仓库已在PYPI上发布，可以直接使用pip安装

``pip install wx-push-services``



从现在开始，您可以直接使用命令行推送本地文件内容，具体操作如下：
在推送消息之前，请于环境变量中添加所需变量如后文所示。在命令行环境下，我们也可以直接使用 ``wx-push-services -cf`` 来指定配置文件。如果您不知道如何生成配置文件，请直接执行 ``wx-push-services`` 程序会在当前目录下自动生成。请按照后文填写必要参数，后续可直接运行。

使用 ``wx-push-services -h`` 查看帮助

.. code-block:: python3

   wx-push-services -m <"messgage text"> -df <disable message_file mode> -mf <message_file_path> -cf <config_file_path>
   # 示例：
   wx-push-services -mf message.log
   wx-push-services -df -m '"消息测试"'


如果您在集成或使用该项目的过程中有任何问题,欢迎提出,我会尽力解答您的疑问。也可以在该项目的GitHub Repo提出Issue获取帮助。


怎样使用微信以及微信推送服务
============================

-  `怎样使用微信以及微信推送服务 <#怎样使用微信以及微信推送服务>`__
-  `主要用途 <#主要用途>`__
-  `实现微信推送服务的两种方式 <#实现微信推送服务的两种方式>`__
-  `使用方式 <#使用方式>`__

   -  `1. 注册企业微信，获取必要token <#1-注册企业微信获取必要token>`__
   -  `2. 安装python运行库 <#2-安装python运行库>`__
   -  `3. 生成并填写配置文件 <#3-生成并填写配置文件>`__
   -  `4. 运行示例 demo <#4-运行示例demo>`__
-  `注意事项 <#注意事项>`__

主要用途
--------
实现微信推送服务的两种方式
--------------------------

1. 调用企业微信应用 使用该种方法时请按照下文方式获得必要token。
2. 使用\ ``web hook``\ 调用企业微信机器人

   使用该种方式时仅需要知道企业微信机器人的\ ``web hook key``\ 。在使用之前，请确保已在企业微信群里中添加企业微信机器人，并按照下文方法获得\ ``web hook key``\ 。

使用方式
--------------------------

1. 注册企业微信，获取必要token
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  使用企业微信应用时获取以下信息：

注册网址：https://work.weixin.qq.com/

1. 获取企业ID


.. figure:: https://s2.loli.net/2023/02/25/9V3l5IGvZiFqMRu.png



在仓库\ ``secrets``\ 中添加如下变量：\ ``CORP_ID=your_id``\

1. 添加应用并获取下述变量

.. figure:: https://s2.loli.net/2023/02/25/XaTm65MjOE3A8iJ.png


.. figure:: https://s2.loli.net/2023/02/25/bkJGwyzZfgIOa7R.png


在仓库\ ``secrets``\ 中添加：\ ``APP_SECRET=your_app_secret``\ 以及\ ``APP_ID=your_app_id``

-  使用机器人\ ``webhook``\ 方式时，请添加以下变量：

.. figure:: https://s2.loli.net/2023/02/25/gOtL3dmJqpBDWIh.png


.. figure:: https://s2.loli.net/2023/02/25/bghHpI3UDvq29lM.png


找到群聊，在其中点击机器人配置，获取\ ``webhookkey``\ 中\ ``key``\ 字段；在仓库中添加\ ``key=your_web_hook_key``\

至此，必要信息已手机完毕。

1. 安装python运行库
~~~~~~~~~~~~~~~~~~~

执行\ ``pip install -r requirments.txt``\



3. 生成并填写配置文件
~~~~~~~~~~~~~~~~~~~~~

初次运行\ ``main.py``\ 中的\ ``demo``\ ，会在当前目录下生成\ ``config.ini``\ 配置文件，如下面代码所示：

.. code:: ini

    [Config]
    corp_id = your corp_id # Enter your enterprise ID of wechat background here.
    app_id = your app_id # Enter your application ID of enterprise wechat background here
    app_secret = your app_secret # Enter your application secret of enterprise wechat background here
    # 使用APP_PUSH方式时以上必填
    # 使用WEB_HOOK_PUSH方式仅需填写下述消息
    key = your key # Enter the webhook key of the enterprise's wechat group chat robot here

依次按照\ ``# .......``\ 中的提示填写必要信息。

4. 运行示例\ ``demo``\
~~~~~~~~~~~~~~~~~~~~~~

在\ ``main.py``\ 中再次运行示例\ ``demo``\

.. code:: python

        # wxps = APP_PUSH()
        hookps = WEB_HOOK_PUSH()
        test = (
            "# 企业微信消息测试"
            + "## •  二级标题"
            + "## •  测试通过"
        )
        hookps.send_message(message=test, markdown=False)

即可发送成功，此时可在微信中看到相应信息。

注意事项
---------
**经过测试。markdown信息并不能在微信查看。只能在企业微信查看。所以，如果想要在微信查看，需要将markdown类型消息改为text类型**