py-wecom 0.1.0__tar.gz

py_wecom-0.1.0/LICENSE

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

py_wecom-0.1.0/PKG-INFO

@@ -0,0 +1,295 @@
+Metadata-Version: 2.4
+Name: py-wecom
+Version: 0.1.0
+Summary: 企业微信 SDK，提供企业微信 API 的 Python 封装，支持同步和异步调用。
+Author-email: Guolei <174000902@qq.com>
+License: MIT License
+        
+        Copyright (c) 2026 郭磊
+        
+        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.
+        
+Project-URL: Homepage, https://gitee.com/guolei19850528/py_wecom
+Project-URL: Repository, https://gitee.com/guolei19850528/py_wecom.git
+Keywords: wecom,python,client,api,企业微信,异步调用,server,消息推送,文件上传
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: jsonpath-ng>=1.5.3
+Requires-Dist: jsonschema>=4.21.0
+Requires-Dist: diskcache>=5.6.3
+Requires-Dist: redis>=4.6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: setuptools>=61.0; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Dynamic: license-file
+
+# py_wecom
+
+企业微信 SDK，提供企业微信 API 的 Python 封装，支持同步和异步调用。
+
+## 功能特性
+
+- **Server API**: 企业微信服务端 API，支持消息发送、素材上传等
+- **Webhook API**: 企业微信机器人 Webhook 接口，支持多种消息类型
+- **同步/异步支持**: 所有接口均提供同步和异步版本
+- **类型安全**: 使用 Pydantic 进行数据验证，提供完整的类型提示
+- **缓存支持**: 支持 Redis 和 diskcache 缓存 access_token
+
+## 安装
+
+```bash
+pip install py_wecom
+```
+
+## 快速开始
+
+### Server API
+
+```python
+from py_wecom.server import Base, Sender, Uploader, Text, TextContent
+
+# 初始化客户端
+server = Base(
+    corpid="your_corp_id",
+    corpsecret="your_corp_secret",
+    agentid="your_agent_id"
+)
+
+# 刷新 access_token
+server.refresh_access_token()
+
+# 发送文本消息
+sender = Sender()
+sender.agentid = server.agentid
+sender.access_token = server.access_token
+
+content = Text(
+    touser="@all",
+    text=TextContent(content="Hello from py_wecom!")
+)
+response = sender.send_text(content=content)
+print(response.json())
+```
+
+### Webhook API
+
+```python
+from py_wecom.webhook import Webhook, Text, TextContent
+
+# 初始化 Webhook 客户端
+webhook = Webhook(key="your_webhook_key")
+
+# 发送文本消息
+content = Text(
+    text=TextContent(
+        content="Hello from py_wecom!",
+        mentioned_list=["@all"]
+    )
+)
+response = webhook.send_text(content=content)
+print(response.json())
+```
+
+## 支持的消息类型
+
+### Server API 支持的消息类型
+
+| 消息类型 | 说明 |
+|---------|------|
+| Text | 文本消息 |
+| Image | 图片消息 |
+| Voice | 语音消息 |
+| Video | 视频消息 |
+| File | 文件消息 |
+| TextCard | 文本卡片消息 |
+| News | 图文消息 |
+| MpNews | 图文消息(mpnews) |
+| Markdown | Markdown消息 |
+| MiniprogramNotice | 小程序通知 |
+| TemplateCard | 模板卡片消息 |
+
+### Webhook API 支持的消息类型
+
+| 消息类型 | 说明 |
+|---------|------|
+| Text | 文本消息 |
+| Markdown | Markdown消息 |
+| MarkdownV2 | MarkdownV2消息（支持更多样式） |
+| Image | 图片消息 |
+| News | 图文消息 |
+| Voice | 语音消息 |
+| File | 文件消息 |
+| TemplateCard | 模板卡片消息 |
+
+## 使用示例
+
+### 发送图片消息 (Server API)
+
+```python
+from py_wecom.server import Base, Sender, Image, ImageContent
+
+server = Base(corpid="xxx", corpsecret="xxx", agentid="xxx")
+server.refresh_access_token()
+
+sender = Sender()
+sender.agentid = server.agentid
+sender.access_token = server.access_token
+
+# 先上传图片获取 media_id
+uploader = Uploader()
+uploader.access_token = server.access_token
+
+# 上传图片
+with open("image.jpg", "rb") as f:
+    upload_response = uploader.upload(
+        file_type="image",
+        files={"media": f}
+    )
+media_id = upload_response.json()["media_id"]
+
+# 发送图片消息
+content = Image(
+    touser="user_id",
+    image=ImageContent(media_id=media_id)
+)
+response = sender.send_image(content=content)
+```
+
+### 发送 Markdown 消息 (Webhook)
+
+```python
+from py_wecom.webhook import Webhook, Markdown, MarkdownContent
+
+webhook = Webhook(key="your_webhook_key")
+
+content = Markdown(
+    markdown=MarkdownContent(
+        content="""
+# 标题
+
+**加粗文本**
+
+*斜体文本*
+
+[链接](https://example.com)
+"""
+    )
+)
+response = webhook.send_markdown(content=content)
+```
+
+### 使用缓存 (Server API)
+
+```python
+import redis
+from py_wecom.server import Base
+
+# 使用 Redis 缓存 access_token
+redis_client = redis.Redis(host="localhost", port=6379, db=0)
+
+server = Base(
+    corpid="xxx",
+    corpsecret="xxx",
+    agentid="xxx",
+    cache_config={
+        "instance": redis_client,
+        "key": "pywecom_access_token",
+        "expire": 7100
+    }
+)
+
+# 刷新 access_token（会自动使用缓存）
+server.refresh_access_token()
+```
+
+## 异步支持
+
+所有方法均提供异步版本，方法名以 `async_` 开头：
+
+```python
+import asyncio
+from py_wecom.server import Base, Sender, Text, TextContent
+
+async def main():
+    server = Base(corpid="xxx", corpsecret="xxx", agentid="xxx")
+    await server.async_refresh_access_token()
+    
+    sender = Sender()
+    sender.agentid = server.agentid
+    sender.access_token = server.access_token
+    
+    content = Text(
+        touser="@all",
+        text=TextContent(content="Hello!")
+    )
+    response = await sender.async_send_text(content=content)
+    print(response.json())
+
+asyncio.run(main())
+```
+
+## 项目结构
+
+```
+py_wecom/
+├── src/
+│   └── py_wecom/
+│       ├── __init__.py
+│       ├── server/           # Server API
+│       │   ├── __init__.py   # Base 类，access_token 管理
+│       │   ├── materials.py  # 素材上传
+│       │   ├── messages.py   # 消息类型和发送
+│       │   ├── responses.py  # 响应模型
+│       │   └── utils.py      # 工具函数
+│       └── webhook/          # Webhook API
+│           ├── __init__.py   # Webhook 客户端
+│           ├── messages.py   # 消息类型
+│           ├── responses.py  # 响应模型
+│           └── utils.py      # 工具函数
+└── README.md
+```
+
+## 参考文档
+
+- [企业微信开发者文档](https://developer.work.weixin.qq.com/document/path/90238)
+- [企业微信机器人文档](https://developer.work.weixin.qq.com/document/path/91770)
+
+## 主页
+
+[https://gitee.com/guolei19850528/py_wecom](https://gitee.com/guolei19850528/py_wecom)
+
+
+
+## 许可证
+
+MIT License

py_wecom-0.1.0/README.md

@@ -0,0 +1,240 @@
+# py_wecom
+
+企业微信 SDK，提供企业微信 API 的 Python 封装，支持同步和异步调用。
+
+## 功能特性
+
+- **Server API**: 企业微信服务端 API，支持消息发送、素材上传等
+- **Webhook API**: 企业微信机器人 Webhook 接口，支持多种消息类型
+- **同步/异步支持**: 所有接口均提供同步和异步版本
+- **类型安全**: 使用 Pydantic 进行数据验证，提供完整的类型提示
+- **缓存支持**: 支持 Redis 和 diskcache 缓存 access_token
+
+## 安装
+
+```bash
+pip install py_wecom
+```
+
+## 快速开始
+
+### Server API
+
+```python
+from py_wecom.server import Base, Sender, Uploader, Text, TextContent
+
+# 初始化客户端
+server = Base(
+    corpid="your_corp_id",
+    corpsecret="your_corp_secret",
+    agentid="your_agent_id"
+)
+
+# 刷新 access_token
+server.refresh_access_token()
+
+# 发送文本消息
+sender = Sender()
+sender.agentid = server.agentid
+sender.access_token = server.access_token
+
+content = Text(
+    touser="@all",
+    text=TextContent(content="Hello from py_wecom!")
+)
+response = sender.send_text(content=content)
+print(response.json())
+```
+
+### Webhook API
+
+```python
+from py_wecom.webhook import Webhook, Text, TextContent
+
+# 初始化 Webhook 客户端
+webhook = Webhook(key="your_webhook_key")
+
+# 发送文本消息
+content = Text(
+    text=TextContent(
+        content="Hello from py_wecom!",
+        mentioned_list=["@all"]
+    )
+)
+response = webhook.send_text(content=content)
+print(response.json())
+```
+
+## 支持的消息类型
+
+### Server API 支持的消息类型
+
+| 消息类型 | 说明 |
+|---------|------|
+| Text | 文本消息 |
+| Image | 图片消息 |
+| Voice | 语音消息 |
+| Video | 视频消息 |
+| File | 文件消息 |
+| TextCard | 文本卡片消息 |
+| News | 图文消息 |
+| MpNews | 图文消息(mpnews) |
+| Markdown | Markdown消息 |
+| MiniprogramNotice | 小程序通知 |
+| TemplateCard | 模板卡片消息 |
+
+### Webhook API 支持的消息类型
+
+| 消息类型 | 说明 |
+|---------|------|
+| Text | 文本消息 |
+| Markdown | Markdown消息 |
+| MarkdownV2 | MarkdownV2消息（支持更多样式） |
+| Image | 图片消息 |
+| News | 图文消息 |
+| Voice | 语音消息 |
+| File | 文件消息 |
+| TemplateCard | 模板卡片消息 |
+
+## 使用示例
+
+### 发送图片消息 (Server API)
+
+```python
+from py_wecom.server import Base, Sender, Image, ImageContent
+
+server = Base(corpid="xxx", corpsecret="xxx", agentid="xxx")
+server.refresh_access_token()
+
+sender = Sender()
+sender.agentid = server.agentid
+sender.access_token = server.access_token
+
+# 先上传图片获取 media_id
+uploader = Uploader()
+uploader.access_token = server.access_token
+
+# 上传图片
+with open("image.jpg", "rb") as f:
+    upload_response = uploader.upload(
+        file_type="image",
+        files={"media": f}
+    )
+media_id = upload_response.json()["media_id"]
+
+# 发送图片消息
+content = Image(
+    touser="user_id",
+    image=ImageContent(media_id=media_id)
+)
+response = sender.send_image(content=content)
+```
+
+### 发送 Markdown 消息 (Webhook)
+
+```python
+from py_wecom.webhook import Webhook, Markdown, MarkdownContent
+
+webhook = Webhook(key="your_webhook_key")
+
+content = Markdown(
+    markdown=MarkdownContent(
+        content="""
+# 标题
+
+**加粗文本**
+
+*斜体文本*
+
+[链接](https://example.com)
+"""
+    )
+)
+response = webhook.send_markdown(content=content)
+```
+
+### 使用缓存 (Server API)
+
+```python
+import redis
+from py_wecom.server import Base
+
+# 使用 Redis 缓存 access_token
+redis_client = redis.Redis(host="localhost", port=6379, db=0)
+
+server = Base(
+    corpid="xxx",
+    corpsecret="xxx",
+    agentid="xxx",
+    cache_config={
+        "instance": redis_client,
+        "key": "pywecom_access_token",
+        "expire": 7100
+    }
+)
+
+# 刷新 access_token（会自动使用缓存）
+server.refresh_access_token()
+```
+
+## 异步支持
+
+所有方法均提供异步版本，方法名以 `async_` 开头：
+
+```python
+import asyncio
+from py_wecom.server import Base, Sender, Text, TextContent
+
+async def main():
+    server = Base(corpid="xxx", corpsecret="xxx", agentid="xxx")
+    await server.async_refresh_access_token()
+    
+    sender = Sender()
+    sender.agentid = server.agentid
+    sender.access_token = server.access_token
+    
+    content = Text(
+        touser="@all",
+        text=TextContent(content="Hello!")
+    )
+    response = await sender.async_send_text(content=content)
+    print(response.json())
+
+asyncio.run(main())
+```
+
+## 项目结构
+
+```
+py_wecom/
+├── src/
+│   └── py_wecom/
+│       ├── __init__.py
+│       ├── server/           # Server API
+│       │   ├── __init__.py   # Base 类，access_token 管理
+│       │   ├── materials.py  # 素材上传
+│       │   ├── messages.py   # 消息类型和发送
+│       │   ├── responses.py  # 响应模型
+│       │   └── utils.py      # 工具函数
+│       └── webhook/          # Webhook API
+│           ├── __init__.py   # Webhook 客户端
+│           ├── messages.py   # 消息类型
+│           ├── responses.py  # 响应模型
+│           └── utils.py      # 工具函数
+└── README.md
+```
+
+## 参考文档
+
+- [企业微信开发者文档](https://developer.work.weixin.qq.com/document/path/90238)
+- [企业微信机器人文档](https://developer.work.weixin.qq.com/document/path/91770)
+
+## 主页
+
+[https://gitee.com/guolei19850528/py_wecom](https://gitee.com/guolei19850528/py_wecom)
+
+
+
+## 许可证
+
+MIT License

py_wecom-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+[project]
+name = "py-wecom"
+version = "0.1.0"
+requires-python = ">=3.10"
+authors = [
+    { name = "Guolei", email = "174000902@qq.com" }
+]
+description = "企业微信 SDK，提供企业微信 API 的 Python 封装，支持同步和异步调用。"
+keywords = ["wecom", "python", "client", "api", "企业微信", "异步调用", "server", "消息推送", "文件上传"]
+license = { file = "LICENSE" }
+readme = "README.md"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "httpx>=0.27.0",
+    "pydantic>=2.0",
+    "jsonpath-ng>=1.5.3",
+    "jsonschema>=4.21.0",
+    "diskcache>=5.6.3",
+    "redis>=4.6.0",
+]
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "setuptools>=61.0",
+    "twine>=4.0",
+]
+
+[project.urls]
+"Homepage" = "https://gitee.com/guolei19850528/py_wecom"
+"Repository" = "https://gitee.com/guolei19850528/py_wecom.git"
+
+[tool.setuptools.packages.find]
+where = ["src"]

py_wecom-0.1.0/setup.cfg

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

py_wecom-0.1.0/src/py_wecom/__init__.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-