pten 0.3.0

A tool to use Wechat work API quickly and easily

pten

pten 是一个方便快捷使用企业微信API的python工具库.

github: https://github.com/bendell02/pten

gitee: https://gitee.com/bendell02/pten

1. 安装

pip install pten

或者源码安装

2. 基础使用 -- 以使用企业机器人发送消息为例

2.1 设置配置文件

配置文件默认路径为 pten_keys.ini，也可以通过 keys_filepath 参数指定配置文件路径。

配置文件完整内容请参考配置文件，并非所有字段都需要设置，根据自己需要配置即可。

比如如果只用企业微信机器人，只需配置 ww的webhook_key字段即可。

[ww]

webhook_key=7ande764-52a4-43d7-a252-05e8abcdb863

2.2 开始使用

from pten.wwmessager import BotMsgSender



bot = BotMsgSender() # 默认使用 pten_keys.ini 配置文件

# bot = BotMsgSender("another_pten_keys.ini") 



# 发送文本消息

response = bot.send_text("hello world") 



# 发送markdown消息

markdown_content = '<font color="info">Hello world</font>'

response = bot.send_markdown(markdown_content)



# 发送图片消息

image_path = "sample_image.png"

response = bot.send_image(image_path)



# 还可发送语音消息、图文消息、文件消息等

3. 配置文件

并非所有字段都需要设置，按需传入

3.1 完整配置文件样例

[ww]

app_aes_key=9z1Cj9cSd7WtEV3hOWo5iMQlFkSP9Td1ejzsV9WhCmO

app_agentid=1000005

app_secret=jVJF_EBWCVA_KVi_89YnY1T1bPD8-0PdqQ2rXc_Pgmj5

app_token=zJdPmXg8E4J1mMdnzP8d

contact_sync_secret=G4PC19fIwfsykabdv_drNVlOIe_crBvay3sUX8DhGss

corpid=wwdb63ff5ae01cd4b4

webhook_key=7ande764-52a4-43d7-a252-05e8abcdb863



[globals]

debug_mode=False



[proxies]

http=http://xxx:[e-mail]:8888

https=http://xxx:[e-mail]:8888



[notice]

;ai

deepseek_api_key=sk-0a6e5b4e8b4c0e1a5b6b8e0e4d5aefb

;weather

seniverse_api_key=v5bFw3o1pSmbGvuEN

3.2 配置文件字段说明

| section | 字段名称 | 字段说明 |

| -------- | -------- | -------- |

| ww | app_aes_key | 应用的aes_key。应用收发消息加解密时使用|

| | app_agentid | 应用的agentid。应用发消息时使用 |

| | app_secret | 应用的secret。服务端API获取access_token时需要使用 |

| | app_token | 应用的token。应用收发消息加解密时使用 |

| | contact_sync_secret | 通讯录的secret。使用通讯录模块时部分API需要使用该secret。通过Contact的contact_sync_secret参数传入 |

| | corpid | corpid。服务端API获取access_token时需要使用 |

| | webhook_key | 企业微信机器人的webhook_key。使用机器人发消息时需要使用 |

| globals | debug_mode | 设置为True时开启调试模式，多一些调试信息 |

| proxies | http | 设置http代理。需要走代理时设置即可 |

| | https | 设置https代理。需要走代理时设置即可 |

| notice | deepseek_api_key | deepseek的api_key。使用Deepseek类回答一些问题时可传入 |

| | seniverse_api_key | 心知天气的api_key。使用Weather类获取天气时可传入 |

• 为什么需要proxies？ 什么情况使用？

因为企业微信API是需要配置可信ip，只有可信ip才能调用API。如果本地网络的ip经常变，那么每次调用API都需要重新配置可信ip，比较麻烦。可以配置代理，让企业微信API调用时走代理，把代理的ip配置到可信ip里，这样就可以避免这个问题。

4. 各个模块使用说明

4.1 wwmessage 模块 : 发送机器人和应用消息

4.1.1 机器人发送消息

from pten.wwmessager import BotMsgSender



bot = BotMsgSender() # 默认使用 pten_keys.ini 配置文件



# 发送文本消息

response = bot.send_text("hello world") 



# 还可发送markdown消息、图片消息、语音消息、图文消息、文件消息等

4.1.2 应用发送消息

from pten.wwmessager import AppMsgSender



app = AppMsgSender()



# 发送文本消息

response = app.send_text("hello world from app")



# 还可发送markdown消息、图片消息、语音消息、图文消息、文件消息、模板卡片消息等

4.2 notice 模块 : 通知功能

4.2.1 获取天气并通知

可配置通过机器人或者应用发送通知，默认打印在控制台

from pten.notice import Weather

from pten.wwmessager import BotMsgSender



weather = Weather()

bot = BotMsgSender()



# 配置通过机器人来发送通知

weather.set_report_func(bot.send_text)



# 添加要获取天气的城市，可添加多个

weather.add_city("深圳", "Shenzhen")



# 发送天气通知，可通过apscheduler定时调用，每天早上通知天气信息

weather.report_weather()

4.2.2 生日提醒

• 农历生日和阳历生日都支持

• 可配置通过机器人或者应用发送通知，默认打印在控制台

• 提醒过后会自动添加下一天的提醒schedule

• 农历生日会自动处理闰月情况

from pten.notice import Birthday

from pten.wwmessager import BotMsgSender



from apscheduler.schedulers.blocking import BlockingScheduler



scheduler = BlockingScheduler()

birthday = Birthday()



# 设置定时器

birthday.set_scheduler(scheduler)



# 设置通过机器人来发送通知

bot = BotMsgSender()

birthday.set_report_func(bot.send_text)



# 添加农历生日提醒

birthday.add_lunar_schedule(3, 15, who="玛丽")

# 可定制提醒内容，填写 greeting_words 参数

birthday.add_lunar_schedule(3, 15, who="玛丽", greeting_words="玛丽来到地球纪念日，生快！")



# 添加阳历生日提醒

birthday.add_solar_schedule(1, 12, who="玛莉亚")



scheduler.start()

4.2.3 获取ai的回答

from pten.notice import Deepseek



deepseek = Deepseek()

content = deepseek.get_completion("简略介绍一下牛顿")

4.3 wwcrypt 模块 : 加解密消息

应用收发消息加解密模块

from pten.keys import Keys

from pten.wwcrypt import WXBizMsgCrypt



keys = Keys()

CORP_ID = keys.get_key("ww", "corpid")

API_TOKEN = keys.get_key("ww", "app_token")

API_AES_KEY = keys.get_key("ww", "app_aes_key")

wxcpt = WXBizMsgCrypt(API_TOKEN, API_AES_KEY, CORP_ID)



# VerifyURL

# ...

ret, sEchoStr = wxcpt.VerifyURL(msg_signature, timestamp, nonce, echostr)



# DecryptMsg

# ...

body = await request.body()

ret, sMsg = wxcpt.DecryptMsg(body.decode("utf-8"), msg_signature, timestamp, nonce)



# EncryptMsg

# ...

ret, send_msg = wxcpt.EncryptMsg(sReplyMsg=sRespData, sNonce=nonce)

4.4 wwcontact 模块 : 通讯录相关API

from pten.wwcontact import Contact



contact = Contact("pten_keys.ini")



userid = "userid"

response = contact.get_user(userid)



department_id = "2"

response = contact.get_user_simple_list(department_id)



department_id = "2"

response = contact.get_user_list(department_id)



## 更多通讯录API可参考源码 

4.5 wwdoc 模块 : 企业微信文档相关API

from pten.wwdoc import Doc



wwdoc = Doc("pten_keys.ini")



# 创建文档

doc_type = 10

doc_name = "test_smart_table2"

admin_users = ["user_a", "user_b"]

response = wwdoc.create_doc(doc_type, doc_name, admin_users=admin_users)



# 智能表格添加视图

docid = "your_docid"

sheet_id = "your_sheetid"

view_title = "view_title"

view_type = "VIEW_TYPE_GRID"

response = wwdoc.smartsheet_add_view(docid, sheet_id, view_title, view_type)



# 智能表格添加字段

fields = [{"field_title": "TITLE", "field_type": "FIELD_TYPE_TEXT"}]

response = wwdoc.smartsheet_add_fields(docid, sheet_id, fields)

assert_response(response)

fields = [

    {

        "field_title": "number",

        "field_type": "FIELD_TYPE_NUMBER",

        "property_number": {"decimal_places": 2, "use_separate": False},

    }

]

response = wwdoc.smartsheet_add_fields(docid, sheet_id, fields)



## 更多企业微信文档API可参考源码 

4.6 wwapi 模块 : 通用API

如果在其他模块中找不到想调用的api，可通过此模块调用

4.6.1 BotApi BOT_API_TYPE

from pten.wwapi import BotApi, BOT_API_TYPE



api = BotApi("pten_keys.ini")

response = api.http_call(

    BOT_API_TYPE["WEBHOOK_SEND"],

    {"msgtype": "text", "text": {"content": "hello from bot"}},

)

4.6.2 CorpApi CORP_API_TYPE

from pten.wwapi import CorpApi, CORP_API_TYPE



api = CorpApi("pten_keys.ini")

response = api.http_call(CORP_API_TYPE["DEPARTMENT_LIST"])



corp_jsapi_ticket = api.get_corp_jsapi_ticket()

app_jsapi_ticket = api.get_app_jsapi_ticket()