目前仓库已在PYPI上发布,可以直接使用pip安装
pip install wx-push-services
从现在开始,您可以直接使用命令行推送本地文件内容,具体操作如下:
在推送消息之前,请于环境变量中添加所需变量如后文所示。在命令行环境下,我们也可以直接使用wx-push-services -cf
来指定配置文件。如果您不知道如何生成配置文件,请直接执行wx-push-services
程序会在当前目录下自动生成。请按照后文填写必要参数,后续可直接运行。
使用 wx-push-services -h
查看帮助
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获取帮助。
- 调用企业微信应用 使用该种方法时请按照下文方式获得必要token。
- 使用
web hook
调用企业微信机器人 使用该种方式时仅需要知道企业微信机器人的web hook key
。在使用之前,请确保已在企业微信群里中添加企业微信机器人,并按照下文方法获得web hook key
。
- 使用企业微信应用时获取以下信息:
注册网址:https://work.weixin.qq.com/
- 获取企业ID
在仓库secrets
中添加如下变量:CORP_ID=your_id
- 添加应用并获取下述变量
在仓库secrets
中添加:APP_SECRET=your_app_secret
以及APP_ID=your_app_id
- 使用机器人
webhook
方式时,请添加以下变量:
找到群聊,在其中点击机器人配置,获取webhookkey
中key
字段;在仓库中添加key=your_web_hook_key
至此,必要信息已手机完毕。
执行pip install -r requirments.txt
初次运行main.py
中的demo
,会在当前目录下生成config.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
依次按照# .......
中的提示填写必要信息。
在main.py
中再次运行示例demo
config = PushConfig() # 默认初始化读取环境变量
config.update_from_ini() # 此时会全部替换参数
# wxps = APP_PUSH()
hookps = WEB_HOOK_PUSH(config.key) # 使用此配置初始化
test = (
"# 企业微信消息测试"
+ "## • 二级标题"
+ "## • 测试通过"
)
# wxps.send_message(message=test, markdown=False)
hookps.send_message(message=test, markdown=False)
即可发送成功,此时可在微信中看到相应信息。
经过测试。markdown信息并不能在微信查看。只能在企业微信查看。所以,如果想要在微信查看,需要将markdown类型消息改为text类型