py-lmobile-toolkit 1.0.0__tar.gz

py_lmobile_toolkit-1.0.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_lmobile_toolkit-1.0.0/PKG-INFO

@@ -0,0 +1,326 @@
+Metadata-Version: 2.4
+Name: py-lmobile-toolkit
+Version: 1.0.0
+Summary: 微网通联（51welink）短信服务 Python SDK，提供同步和异步两种发送方式，支持请求签名认证
+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_lmobile_toolkit
+Project-URL: Repository, https://gitee.com/guolei19850528/py_lmobile_toolkit.git
+Project-URL: Documentation, https://www.lmobile.cn/ApiPages/index.html
+Keywords: lmobile,python,client,api,微网通联,短信,sms,51welink
+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
+Classifier: Topic :: Communications
+Classifier: Topic :: Communications :: Telephony
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+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: py-httpx-toolkit>=1.0.1
+Dynamic: license-file
+
+# py-lmobile-toolkit
+
+微网通联（51welink）短信服务 Python SDK，提供同步和异步两种发送方式，支持请求签名认证机制。
+
+## 作者
+
+**Guolei**
+
+- 邮箱：174000902@qq.com
+
+## 项目主页
+
+- **Gitee**: https://gitee.com/guolei19850528/py_lmobile_toolkit
+- **官方 API 文档**: https://www.lmobile.cn/ApiPages/index.html
+
+## 功能特性
+
+- ✅ 同步短信发送接口
+- ✅ 异步短信发送接口
+- ✅ 请求签名认证机制（SHA256）
+- ✅ 响应数据模型验证（Pydantic）
+- ✅ 完整的工具函数支持
+
+## 安装
+
+使用 `uv` 安装：
+
+```bash
+uv add py-lmobile-toolkit
+```
+
+或从pip安装：
+
+```bash
+pip install py-lmobile-toolkit
+```
+
+## 依赖包
+
+| 依赖 | 版本要求 | 说明 |
+|------|----------|------|
+| httpx | >=0.27.0 | HTTP 客户端 |
+| pydantic | >=2.0 | 数据验证 |
+| jsonpath-ng | >=1.5.3 | JSONPath 查询 |
+| jsonschema | >=4.21.0 | JSON Schema 校验 |
+| py-httpx-toolkit | >=1.0.1 | HTTP 工具封装 |
+
+## API 接口
+
+### Sms 类
+
+短信客户端核心类，提供同步和异步发送接口。
+
+#### 初始化
+
+```python
+from py_lmobile_toolkit.sms import Sms
+
+sms = Sms(
+    account_id="your_account",
+    password="your_password",
+    product_id="your_product"
+)
+```
+
+**参数说明**:
+
+| 参数 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| base_url | str | https://api.51welink.com/ | API 服务器地址 |
+| account_id | str | None | 账号 ID |
+| password | str | None | 账号密码 |
+| product_id | str/int | None | 产品 ID |
+| smms_encrypt_key | str | SMmsEncryptKey | 加密密钥 |
+| client_kwargs | dict | None | httpx.Client 配置 |
+
+#### 同步发送
+
+```python
+response = sms.send(
+    phone_nos="13800138000",
+    content="您的验证码是：123456"
+)
+```
+
+#### 异步发送
+
+```python
+response = await sms.async_send(
+    phone_nos=["13800138000", "13900139000"],
+    content="测试短信"
+)
+```
+
+**参数说明**:
+
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| phone_nos | str/list/tuple | 手机号码，支持单个或多个 |
+| content | str | 短信内容 |
+| client | httpx.Client/AsyncClient | 可选的客户端实例 |
+| client_kwargs | dict | 客户端配置 |
+
+## Utils 工具函数
+
+### 时间戳生成
+
+```python
+from py_lmobile_toolkit.sms.utils import timestamp
+
+ts = timestamp()  # 返回毫秒级时间戳
+```
+
+### 随机数生成
+
+```python
+from py_lmobile_toolkit.sms.utils import random_digits
+
+digits = random_digits(length=10)  # 生成10位随机数
+```
+
+### SHA256 签名生成
+
+```python
+from py_lmobile_toolkit.sms.utils import sha256_signature
+
+signature = sha256_signature(
+    account_id="dljtwy00",
+    password="g07KjuLN1",
+    phone_nos="13800138000",
+    random_digits="1234567890",
+    timestamp="1630000000000",
+    smms_encrypt_key="SMmsEncryptKey"
+)
+```
+
+### JSONPath 查询
+
+```python
+from py_lmobile_toolkit.sms.utils import json_find_first
+
+data = {"store": {"books": [{"title": "Python"}, {"title": "Java"}]}}
+title = json_find_first("$.store.books[0].title", data)  # 返回 "Python"
+```
+
+### JSON Schema 校验
+
+```python
+from py_lmobile_toolkit.sms.utils import json_is_valid
+
+schema = {"type": "object", "properties": {"name": {"type": "string"}}}
+valid = json_is_valid(schema, {"name": "test"})  # 返回 True
+```
+
+### 响应模型转换
+
+```python
+from py_lmobile_toolkit.sms.utils import build_success_instance
+
+result = build_success_instance(response)  # 转换为 Success 模型
+```
+
+## 响应模型
+
+### Base
+
+所有响应的基类：
+
+```python
+from py_lmobile_toolkit.sms.responses import Base
+
+class Base(BaseModel):
+    Result: str  # 错误码，succ 表示成功
+```
+
+### Success
+
+成功响应模型：
+
+```python
+from py_lmobile_toolkit.sms.responses import Success
+
+result = Success(Result="succ")
+```
+
+## 使用示例
+
+### 同步发送示例
+
+```python
+from py_lmobile_toolkit.sms import Sms
+
+# 初始化客户端
+sms = Sms(
+    account_id="your_account",
+    password="your_password",
+    product_id="your_product"
+)
+
+# 发送单条短信
+response = sms.send(
+    phone_nos="13800138000",
+    content="您的验证码是：123456"
+)
+
+# 解析响应
+data = response.json()
+print(f"发送结果: {data.get('Result')}")
+```
+
+### 异步发送示例
+
+```python
+import asyncio
+from py_lmobile_toolkit.sms import Sms
+
+async def main():
+    # 初始化客户端
+    sms = Sms(
+        account_id="your_account",
+        password="your_password",
+        product_id="your_product"
+    )
+
+    # 批量发送短信
+    response = await sms.async_send(
+        phone_nos=["13800138000", "13900139000", "13700137000"],
+        content="【通知】您的订单已发货"
+    )
+
+    # 解析响应
+    data = response.json()
+    print(f"发送结果: {data.get('Result')}")
+
+asyncio.run(main())
+```
+
+### 签名验证示例
+
+```python
+from py_lmobile_toolkit.sms.utils import sha256_signature, timestamp, random_digits
+
+# 生成签名所需参数
+ts = timestamp()
+digits = random_digits()
+
+# 生成签名
+signature = sha256_signature(
+    account_id="your_account",
+    password="your_password",
+    phone_nos="13800138000",
+    random_digits=digits,
+    timestamp=ts,
+    smms_encrypt_key="SMmsEncryptKey"
+)
+
+print(f"生成的签名: {signature}")
+```
+
+## 签名生成算法
+
+签名生成遵循以下步骤：
+
+1. **密码 MD5 加密**：`MD5(password + smms_encrypt_key)`，结果转大写
+2. **参数拼接**（按顺序）：
+   ```
+   AccountId={account_id}&PhoneNos={first_phone}&Password={md5_password}&Random={random}&Timestamp={timestamp}
+   ```
+3. **SHA256 加密**：对拼接后的字符串进行 SHA256 哈希
+
+## 许可证
+
+MIT License

py_lmobile_toolkit-1.0.0/README.md

@@ -0,0 +1,273 @@
+# py-lmobile-toolkit
+
+微网通联（51welink）短信服务 Python SDK，提供同步和异步两种发送方式，支持请求签名认证机制。
+
+## 作者
+
+**Guolei**
+
+- 邮箱：174000902@qq.com
+
+## 项目主页
+
+- **Gitee**: https://gitee.com/guolei19850528/py_lmobile_toolkit
+- **官方 API 文档**: https://www.lmobile.cn/ApiPages/index.html
+
+## 功能特性
+
+- ✅ 同步短信发送接口
+- ✅ 异步短信发送接口
+- ✅ 请求签名认证机制（SHA256）
+- ✅ 响应数据模型验证（Pydantic）
+- ✅ 完整的工具函数支持
+
+## 安装
+
+使用 `uv` 安装：
+
+```bash
+uv add py-lmobile-toolkit
+```
+
+或从pip安装：
+
+```bash
+pip install py-lmobile-toolkit
+```
+
+## 依赖包
+
+| 依赖 | 版本要求 | 说明 |
+|------|----------|------|
+| httpx | >=0.27.0 | HTTP 客户端 |
+| pydantic | >=2.0 | 数据验证 |
+| jsonpath-ng | >=1.5.3 | JSONPath 查询 |
+| jsonschema | >=4.21.0 | JSON Schema 校验 |
+| py-httpx-toolkit | >=1.0.1 | HTTP 工具封装 |
+
+## API 接口
+
+### Sms 类
+
+短信客户端核心类，提供同步和异步发送接口。
+
+#### 初始化
+
+```python
+from py_lmobile_toolkit.sms import Sms
+
+sms = Sms(
+    account_id="your_account",
+    password="your_password",
+    product_id="your_product"
+)
+```
+
+**参数说明**:
+
+| 参数 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| base_url | str | https://api.51welink.com/ | API 服务器地址 |
+| account_id | str | None | 账号 ID |
+| password | str | None | 账号密码 |
+| product_id | str/int | None | 产品 ID |
+| smms_encrypt_key | str | SMmsEncryptKey | 加密密钥 |
+| client_kwargs | dict | None | httpx.Client 配置 |
+
+#### 同步发送
+
+```python
+response = sms.send(
+    phone_nos="13800138000",
+    content="您的验证码是：123456"
+)
+```
+
+#### 异步发送
+
+```python
+response = await sms.async_send(
+    phone_nos=["13800138000", "13900139000"],
+    content="测试短信"
+)
+```
+
+**参数说明**:
+
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| phone_nos | str/list/tuple | 手机号码，支持单个或多个 |
+| content | str | 短信内容 |
+| client | httpx.Client/AsyncClient | 可选的客户端实例 |
+| client_kwargs | dict | 客户端配置 |
+
+## Utils 工具函数
+
+### 时间戳生成
+
+```python
+from py_lmobile_toolkit.sms.utils import timestamp
+
+ts = timestamp()  # 返回毫秒级时间戳
+```
+
+### 随机数生成
+
+```python
+from py_lmobile_toolkit.sms.utils import random_digits
+
+digits = random_digits(length=10)  # 生成10位随机数
+```
+
+### SHA256 签名生成
+
+```python
+from py_lmobile_toolkit.sms.utils import sha256_signature
+
+signature = sha256_signature(
+    account_id="dljtwy00",
+    password="g07KjuLN1",
+    phone_nos="13800138000",
+    random_digits="1234567890",
+    timestamp="1630000000000",
+    smms_encrypt_key="SMmsEncryptKey"
+)
+```
+
+### JSONPath 查询
+
+```python
+from py_lmobile_toolkit.sms.utils import json_find_first
+
+data = {"store": {"books": [{"title": "Python"}, {"title": "Java"}]}}
+title = json_find_first("$.store.books[0].title", data)  # 返回 "Python"
+```
+
+### JSON Schema 校验
+
+```python
+from py_lmobile_toolkit.sms.utils import json_is_valid
+
+schema = {"type": "object", "properties": {"name": {"type": "string"}}}
+valid = json_is_valid(schema, {"name": "test"})  # 返回 True
+```
+
+### 响应模型转换
+
+```python
+from py_lmobile_toolkit.sms.utils import build_success_instance
+
+result = build_success_instance(response)  # 转换为 Success 模型
+```
+
+## 响应模型
+
+### Base
+
+所有响应的基类：
+
+```python
+from py_lmobile_toolkit.sms.responses import Base
+
+class Base(BaseModel):
+    Result: str  # 错误码，succ 表示成功
+```
+
+### Success
+
+成功响应模型：
+
+```python
+from py_lmobile_toolkit.sms.responses import Success
+
+result = Success(Result="succ")
+```
+
+## 使用示例
+
+### 同步发送示例
+
+```python
+from py_lmobile_toolkit.sms import Sms
+
+# 初始化客户端
+sms = Sms(
+    account_id="your_account",
+    password="your_password",
+    product_id="your_product"
+)
+
+# 发送单条短信
+response = sms.send(
+    phone_nos="13800138000",
+    content="您的验证码是：123456"
+)
+
+# 解析响应
+data = response.json()
+print(f"发送结果: {data.get('Result')}")
+```
+
+### 异步发送示例
+
+```python
+import asyncio
+from py_lmobile_toolkit.sms import Sms
+
+async def main():
+    # 初始化客户端
+    sms = Sms(
+        account_id="your_account",
+        password="your_password",
+        product_id="your_product"
+    )
+
+    # 批量发送短信
+    response = await sms.async_send(
+        phone_nos=["13800138000", "13900139000", "13700137000"],
+        content="【通知】您的订单已发货"
+    )
+
+    # 解析响应
+    data = response.json()
+    print(f"发送结果: {data.get('Result')}")
+
+asyncio.run(main())
+```
+
+### 签名验证示例
+
+```python
+from py_lmobile_toolkit.sms.utils import sha256_signature, timestamp, random_digits
+
+# 生成签名所需参数
+ts = timestamp()
+digits = random_digits()
+
+# 生成签名
+signature = sha256_signature(
+    account_id="your_account",
+    password="your_password",
+    phone_nos="13800138000",
+    random_digits=digits,
+    timestamp=ts,
+    smms_encrypt_key="SMmsEncryptKey"
+)
+
+print(f"生成的签名: {signature}")
+```
+
+## 签名生成算法
+
+签名生成遵循以下步骤：
+
+1. **密码 MD5 加密**：`MD5(password + smms_encrypt_key)`，结果转大写
+2. **参数拼接**（按顺序）：
+   ```
+   AccountId={account_id}&PhoneNos={first_phone}&Password={md5_password}&Random={random}&Timestamp={timestamp}
+   ```
+3. **SHA256 加密**：对拼接后的字符串进行 SHA256 哈希
+
+## 许可证
+
+MIT License

py_lmobile_toolkit-1.0.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "py-lmobile-toolkit"
+version = "1.0.0"
+requires-python = ">=3.10"
+authors = [
+    { name = "Guolei", email = "174000902@qq.com" }
+]
+description = "微网通联（51welink）短信服务 Python SDK，提供同步和异步两种发送方式，支持请求签名认证"
+readme = "README.md"
+license = { file = "LICENSE" }
+keywords = ["lmobile", "python", "client", "api", "微网通联", "短信", "sms", "51welink"]
+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",
+    "Topic :: Communications",
+    "Topic :: Communications :: Telephony",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "httpx>=0.27.0",
+    "pydantic>=2.0",
+    "jsonpath-ng>=1.5.3",
+    "jsonschema>=4.21.0",
+    "py-httpx-toolkit>=1.0.1",
+]
+
+
+[project.urls]
+"Homepage" = "https://gitee.com/guolei19850528/py_lmobile_toolkit"
+"Repository" = "https://gitee.com/guolei19850528/py_lmobile_toolkit.git"
+"Documentation" = "https://www.lmobile.cn/ApiPages/index.html"
+
+[tool.setuptools.packages.find]
+where = ["src"]

py_lmobile_toolkit-1.0.0/setup.cfg

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

py_lmobile_toolkit-1.0.0/src/py_lmobile_toolkit/__init__.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-
+"""
+py_lmobile - 微网通联短信服务 Python SDK
+
+本模块提供接入微网通联（51welink）短信服务的完整功能，包括：
+- 同步和异步短信发送能力
+- 请求签名认证机制
+- 响应数据模型
+- 工具函数支持
+
+主要组件：
+- Sms: 短信客户端核心类，提供同步和异步发送接口
+- utils: 工具函数模块，包含签名生成、时间戳等功能
+- responses: 响应数据模型，用于标准化API响应
+
+官方 API 文档：https://www.lmobile.cn/ApiPages/index.html
+
+使用示例：
+    from py_lmobile.sms import Sms
+    
+    sms = Sms(account_id="your_account", password="your_password", product_id="your_product")
+    response = sms.send(phone_nos="13800138000", content="您的验证码是：123456")
+"""