wechat-publish-sdk 1.0.0__tar.gz

wechat_publish_sdk-1.0.0/LICENSE

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

wechat_publish_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: wechat-publish-sdk
+Version: 1.0.0
+Summary: 微信公众号发布服务 Python SDK
+Author-email: Tang Cheng <tangcheng@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/tangcheng/wechat-publish-service
+Project-URL: Documentation, https://github.com/tangcheng/wechat-publish-service#readme
+Project-URL: Repository, https://github.com/tangcheng/wechat-publish-service.git
+Keywords: wechat,publish,sdk,api,mp
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Dynamic: license-file
+
+# WeChat Publish SDK
+
+微信公众号发布服务的 Python SDK，提供稳定、易用的 API 接口。
+
+## 特性
+
+- ✅ **API 版本化** - 通过 `api_version` 参数支持多个版本
+- ✅ **自动签名** - 无需手动计算 HMAC-SHA256 签名
+- ✅ **类型安全** - 完整的类型注解，IDE 提示友好
+- ✅ **错误处理** - 统一的异常体系
+- ✅ **简洁易用** - 一个客户端解决所有操作
+- ✅ **默认账号** - 设置 `default_account` 后无需每次传 account
+
+## 安装
+
+```bash
+pip install wechat-publish-sdk
+```
+
+## 快速开始
+
+### 初始化客户端
+
+```python
+import os
+from wechat_publish_sdk import WeChatClient
+
+client = WeChatClient(
+    base_url="http://localhost:3000",
+    signing_key=os.getenv("SIGNING_KEY"),
+    default_account="mingdeng",  # 可选：设置默认账号
+    api_version="v1"  # 可选：默认 "v1"
+)
+```
+
+### 发布文章
+
+```python
+from wechat_publish_sdk import WeChatClient, PublishRequest
+
+# 基本发布
+result = client.publish_article(
+    PublishRequest(
+        title="测试文章",
+        content="# 这是测试内容"
+    )
+)
+
+if result.success:
+    print(f"发布成功，draft_id: {result.draft_id}")
+else:
+    print(f"发布失败: {result.message}")
+```
+
+### 发布带封面的文章
+
+```python
+# 先上传封面
+upload_result = client.upload_image(
+    UploadRequest(
+        account="mingdeng",
+        file_path="path/to/cover.jpg"
+    )
+)
+
+if upload_result.success:
+    media_id = upload_result.media_id
+
+    # 发布文章时使用封面
+    result = client.publish_article(
+        PublishRequest(
+            title="带封面的文章",
+            content="# 文章内容",
+            thumb_media_id=media_id,
+            show_cover_pic=1,
+            author="作者名",
+            digest="文章摘要"
+        )
+    )
+```
+
+### 批量发布
+
+```python
+articles = [
+    {"title": "文章1", "content": "内容1"},
+    {"title": "文章2", "content": "内容2"},
+    {"title": "文章3", "content": "内容3"},
+]
+
+for article in articles:
+    result = client.publish_article(
+        PublishRequest(**article)
+    )
+    print(f"{article['title']}: {result.message}")
+```
+
+### 查询素材列表
+
+```python
+result = client.list_materials(
+    account="mingdeng",
+    material_type="image",
+    offset=0,
+    count=20
+)
+
+if result.success:
+    print(f"共 {result.total_count} 个素材")
+    for item in result.items:
+        print(f"  - {item.name}: {item.url}")
+```
+
+### Markdown 渲染
+
+```python
+from wechat_publish_sdk import RenderRequest
+
+result = client.render_markdown(
+    RenderRequest(
+        content="# 标题\n\n内容",
+        theme="orange"
+    )
+)
+
+if result.success:
+    print(result.html)
+```
+
+## API 版本控制
+
+SDK 支持多版本 API，通过初始化时指定 `api_version` 参数：
+
+```python
+# 使用 v1 稳定版
+client_v1 = WeChatClient(
+    base_url="http://localhost:3000",
+    signing_key="key",
+    api_version="v1"
+)
+
+# 使用 dev 开发版
+client_dev = WeChatClient(
+    base_url="http://localhost:3000",
+    signing_key="key",
+    api_version="dev"
+)
+```
+
+## 异常处理
+
+```python
+from wechat_publish_sdk import (
+    WeChatClient, PublishRequest,
+    ValidationError, AccountNotFoundError, PublishFailedError
+)
+
+try:
+    result = client.publish_article(PublishRequest(...))
+except ValidationError as e:
+    print(f"参数错误: {e}")
+except AccountNotFoundError as e:
+    print(f"账号不存在: {e}")
+except PublishFailedError as e:
+    print(f"发布失败: {e}")
+except WeChatPublishError as e:
+    print(f"其他错误: {e}")
+```
+
+## 配置说明
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| base_url | str | 是 | 后端服务地址 |
+| signing_key | str | 是 | HMAC 签名密钥（十六进制）|
+| default_account | str | 否 | 默认账号 |
+| api_version | str | 否 | API 版本，默认 "v1" |
+| timeout | int | 否 | 请求超时（秒），默认 30 |
+
+## 开发
+
+```bash
+# 克隆项目
+git clone https://github.com/tangcheng/wechat-publish-sdk.git
+
+# 安装开发依赖
+pip install -e ".[dev]"
+
+# 运行测试
+pytest
+
+# 代码格式化
+black wechat_publish_sdk/
+
+# 类型检查
+mypy wechat_publish_sdk/
+```
+
+## License
+
+MIT License

wechat_publish_sdk-1.0.0/README.md

@@ -0,0 +1,201 @@
+# WeChat Publish SDK
+
+微信公众号发布服务的 Python SDK，提供稳定、易用的 API 接口。
+
+## 特性
+
+- ✅ **API 版本化** - 通过 `api_version` 参数支持多个版本
+- ✅ **自动签名** - 无需手动计算 HMAC-SHA256 签名
+- ✅ **类型安全** - 完整的类型注解，IDE 提示友好
+- ✅ **错误处理** - 统一的异常体系
+- ✅ **简洁易用** - 一个客户端解决所有操作
+- ✅ **默认账号** - 设置 `default_account` 后无需每次传 account
+
+## 安装
+
+```bash
+pip install wechat-publish-sdk
+```
+
+## 快速开始
+
+### 初始化客户端
+
+```python
+import os
+from wechat_publish_sdk import WeChatClient
+
+client = WeChatClient(
+    base_url="http://localhost:3000",
+    signing_key=os.getenv("SIGNING_KEY"),
+    default_account="mingdeng",  # 可选：设置默认账号
+    api_version="v1"  # 可选：默认 "v1"
+)
+```
+
+### 发布文章
+
+```python
+from wechat_publish_sdk import WeChatClient, PublishRequest
+
+# 基本发布
+result = client.publish_article(
+    PublishRequest(
+        title="测试文章",
+        content="# 这是测试内容"
+    )
+)
+
+if result.success:
+    print(f"发布成功，draft_id: {result.draft_id}")
+else:
+    print(f"发布失败: {result.message}")
+```
+
+### 发布带封面的文章
+
+```python
+# 先上传封面
+upload_result = client.upload_image(
+    UploadRequest(
+        account="mingdeng",
+        file_path="path/to/cover.jpg"
+    )
+)
+
+if upload_result.success:
+    media_id = upload_result.media_id
+
+    # 发布文章时使用封面
+    result = client.publish_article(
+        PublishRequest(
+            title="带封面的文章",
+            content="# 文章内容",
+            thumb_media_id=media_id,
+            show_cover_pic=1,
+            author="作者名",
+            digest="文章摘要"
+        )
+    )
+```
+
+### 批量发布
+
+```python
+articles = [
+    {"title": "文章1", "content": "内容1"},
+    {"title": "文章2", "content": "内容2"},
+    {"title": "文章3", "content": "内容3"},
+]
+
+for article in articles:
+    result = client.publish_article(
+        PublishRequest(**article)
+    )
+    print(f"{article['title']}: {result.message}")
+```
+
+### 查询素材列表
+
+```python
+result = client.list_materials(
+    account="mingdeng",
+    material_type="image",
+    offset=0,
+    count=20
+)
+
+if result.success:
+    print(f"共 {result.total_count} 个素材")
+    for item in result.items:
+        print(f"  - {item.name}: {item.url}")
+```
+
+### Markdown 渲染
+
+```python
+from wechat_publish_sdk import RenderRequest
+
+result = client.render_markdown(
+    RenderRequest(
+        content="# 标题\n\n内容",
+        theme="orange"
+    )
+)
+
+if result.success:
+    print(result.html)
+```
+
+## API 版本控制
+
+SDK 支持多版本 API，通过初始化时指定 `api_version` 参数：
+
+```python
+# 使用 v1 稳定版
+client_v1 = WeChatClient(
+    base_url="http://localhost:3000",
+    signing_key="key",
+    api_version="v1"
+)
+
+# 使用 dev 开发版
+client_dev = WeChatClient(
+    base_url="http://localhost:3000",
+    signing_key="key",
+    api_version="dev"
+)
+```
+
+## 异常处理
+
+```python
+from wechat_publish_sdk import (
+    WeChatClient, PublishRequest,
+    ValidationError, AccountNotFoundError, PublishFailedError
+)
+
+try:
+    result = client.publish_article(PublishRequest(...))
+except ValidationError as e:
+    print(f"参数错误: {e}")
+except AccountNotFoundError as e:
+    print(f"账号不存在: {e}")
+except PublishFailedError as e:
+    print(f"发布失败: {e}")
+except WeChatPublishError as e:
+    print(f"其他错误: {e}")
+```
+
+## 配置说明
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| base_url | str | 是 | 后端服务地址 |
+| signing_key | str | 是 | HMAC 签名密钥（十六进制）|
+| default_account | str | 否 | 默认账号 |
+| api_version | str | 否 | API 版本，默认 "v1" |
+| timeout | int | 否 | 请求超时（秒），默认 30 |
+
+## 开发
+
+```bash
+# 克隆项目
+git clone https://github.com/tangcheng/wechat-publish-sdk.git
+
+# 安装开发依赖
+pip install -e ".[dev]"
+
+# 运行测试
+pytest
+
+# 代码格式化
+black wechat_publish_sdk/
+
+# 类型检查
+mypy wechat_publish_sdk/
+```
+
+## License
+
+MIT License

wechat_publish_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "wechat-publish-sdk"
+version = "1.0.0"
+description = "微信公众号发布服务 Python SDK"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    {name = "Tang Cheng", email = "tangcheng@example.com"}
+]
+keywords = ["wechat", "publish", "sdk", "api", "mp"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+dependencies = [
+    "requests>=2.28.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "black>=23.0",
+    "mypy>=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/tangcheng/wechat-publish-service"
+Documentation = "https://github.com/tangcheng/wechat-publish-service#readme"
+Repository = "https://github.com/tangcheng/wechat-publish-service.git"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["wechat_publish_sdk*"]
+
+[tool.black]
+line-length = 100
+target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false

wechat_publish_sdk-1.0.0/setup.cfg

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

wechat_publish_sdk-1.0.0/tests/test_client.py

@@ -0,0 +1,156 @@
+"""单元测试"""
+import pytest
+from unittest.mock import Mock, patch, MagicMock
+from wechat_publish_sdk import WeChatClient, PublishRequest, ValidationError
+from wechat_publish_sdk.exceptions import AccountNotFoundError
+
+
+class TestWeChatClient:
+    """客户端测试"""
+
+    def test_init(self):
+        """测试客户端初始化"""
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64  # 64 hex chars = 32 bytes
+        )
+        assert client.base_url == "http://localhost:3000"
+        assert client.api_version == "v1"
+        assert client.endpoint_base == "http://localhost:3000/api/v1/mp"
+
+    def test_init_with_custom_version(self):
+        """测试自定义版本"""
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64,
+            api_version="dev"
+        )
+        assert client.api_version == "dev"
+        assert client.endpoint_base == "http://localhost:3000/api/dev/mp"
+
+    def test_make_signature(self):
+        """测试签名生成"""
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64
+        )
+        sig = client._make_signature("test_account", 1234567890, "body_hash_value")
+        assert isinstance(sig, str)
+        assert len(sig) == 64  # SHA256 hex = 64 chars
+
+    def test_get_account_with_default(self):
+        """测试使用默认账号"""
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64,
+            default_account="default_account"
+        )
+        account = client._get_account()
+        assert account == "default_account"
+
+    def test_get_account_without_default_raises(self):
+        """测试无默认账号且不传 account 时抛异常"""
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64
+        )
+        with pytest.raises(ValidationError):
+            client._get_account()
+
+    def test_get_account_explicit(self):
+        """测试显式指定账号"""
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64,
+            default_account="default"
+        )
+        account = client._get_account("explicit_account")
+        assert account == "explicit_account"
+
+    @patch('wechat_publish_sdk.client.requests.Session.post')
+    def test_publish_article_success(self, mock_post):
+        """测试发布文章成功"""
+        mock_post.return_value = Mock(
+            json=lambda: {"success": True, "message": "发布成功", "draft_id": "draft_123"}
+        )
+
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64,
+            default_account="test_account"
+        )
+
+        result = client.publish_article(
+            PublishRequest(
+                title="测试标题",
+                content="# 测试内容"
+            )
+        )
+
+        assert result.success is True
+        assert result.draft_id == "draft_123"
+        assert mock_post.called
+
+    @patch('wechat_publish_sdk.client.requests.Session.post')
+    def test_publish_article_404(self, mock_post):
+        """测试发布文章 404"""
+        mock_post.return_value = Mock(
+            status_code=404,
+            json=lambda: {"success": False, "message": "接口不存在"}
+        )
+
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64,
+            default_account="test_account"
+        )
+
+        with pytest.raises(AccountNotFoundError):
+            client.publish_article(
+                PublishRequest(
+                    title="测试",
+                    content="内容"
+                )
+            )
+
+    def test_publish_article_validation_error(self):
+        """测试参数验证失败"""
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64
+        )
+
+        with pytest.raises(ValidationError):
+            client.publish_article(
+                PublishRequest(
+                    title="",  # 空标题
+                    content="内容"
+                )
+            )
+
+        with pytest.raises(ValidationError):
+            client.publish_article(
+                PublishRequest(
+                    title="标题",
+                    content=""  # 空内容
+                )
+            )
+
+    @patch('wechat_publish_sdk.client.os.path.exists')
+    def test_upload_image_file_not_found(self, mock_exists):
+        """测试文件不存在"""
+        mock_exists.return_value = False
+
+        client = WeChatClient(
+            base_url="http://localhost:3000",
+            signing_key="a" * 64
+        )
+
+        from wechat_publish_sdk import UploadRequest
+        with pytest.raises(ValidationError):
+            client.upload_image(
+                UploadRequest(
+                    account="test",
+                    file_path="/nonexistent/file.jpg"
+                )
+            )