pytbox 20250818.2__py3-none-any.whl

pytbox/common/__init__.py

@@ -0,0 +1,7 @@
+"""
+Common utilities and base classes
+"""
+
+from .base import BaseAPI, BaseResponse
+
+__all__ = ["BaseAPI", "BaseResponse"]

pytbox/common/base.py

@@ -0,0 +1,44 @@
+"""
+Base classes and common utilities
+"""
+
+from ..utils.timeutils import TimeUtils
+from typing import Dict, Any
+import json
+
+
+class BaseAPI:
+    """API基类，提供通用功能"""
+    
+    def __init__(self, base_url: str = ""):
+        self.base_url = base_url
+        self._session_created_at = TimeUtils.get_timestamp()
+    
+    def get_session_age(self) -> int:
+        """获取会话存活时间（秒）"""
+        current_time = TimeUtils.get_timestamp()
+        return current_time - self._session_created_at
+    
+    def log_request(self, method: str, url: str, data: Dict[Any, Any] = None) -> str:
+        """记录请求日志"""
+        timestamp = TimeUtils.get_timestamp()
+        log_entry = {
+            "timestamp": timestamp,
+            "method": method,
+            "url": url,
+            "data": data or {}
+        }
+        return json.dumps(log_entry, ensure_ascii=False)
+
+
+class BaseResponse:
+    """响应基类"""
+    
+    def __init__(self, data: Dict[Any, Any]):
+        self.data = data
+        self.created_at = TimeUtils.get_timestamp()
+        
+    def is_expired(self, ttl_seconds: int = 3600) -> bool:
+        """检查响应是否过期"""
+        current_time = TimeUtils.get_timestamp()
+        return (current_time - self.created_at) > ttl_seconds

pytbox/timeutils.py

@@ -0,0 +1 @@
+ 

pytbox/utils/response.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+
+from dataclasses import dataclass
+from typing import Any, Optional
+
+
+@dataclass
+class ReturnResponse:
+    """统一响应格式类
+    
+    Attributes:
+        code: 响应状态码
+            0 - 成功 (SUCCESS)
+            1 - 一般错误 (ERROR)
+            2 - 警告 (WARNING)
+            3 - 未授权 (UNAUTHORIZED)
+            4 - 资源未找到 (NOT_FOUND)
+            5 - 请求超时 (TIMEOUT)
+            6 - 参数错误 (INVALID_PARAMS)
+            7 - 权限不足 (PERMISSION_DENIED)
+            8 - 服务不可用 (SERVICE_UNAVAILABLE)
+            9 - 数据库错误 (DATABASE_ERROR)
+            10 - 网络错误 (NETWORK_ERROR)
+        message: 响应消息描述
+        data: 响应数据，可以是任意类型
+    """
+    code: int = 0
+    msg: str = ''
+    data: Optional[Any] = None
+    
+    def is_success(self) -> bool:
+        """判断是否为成功响应
+        
+        Returns:
+            bool: code为0时返回True，否则返回False
+        """
+        return self.code == 0
+    
+    def is_error(self) -> bool:
+        """判断是否为错误响应
+        
+        Returns:
+            bool: code不为0时返回True，否则返回False
+        """
+        return self.code != 0

pytbox/utils/timeutils.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+
+
+import time
+
+
+class TimeUtils:
+    
+    @staticmethod
+    def get_timestamp(now: bool=True) -> int:
+        '''
+        获取时间戳
+        
+        Args:
+            now (bool, optional): _description_. Defaults to True.
+
+        Returns:
+            _type_: _description_
+        '''
+        if now:
+            return int(time.time())
+        else:
+            return int(time.time() * 1000)

pytbox/victoriametrics.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+
+import requests
+from .utils.response import ReturnResponse
+
+
+class VictoriaMetrics:
+    
+    def __init__(self, url: str='', timeout: int=3) -> None:
+        self.url = url
+        self.timeout = timeout
+        self.session = requests.Session()
+        self.session.headers.update({
+            'Content-Type': 'application/json',
+            'Accept': 'application/json'
+        })
+        
+    def query(self, query: str) -> ReturnResponse:
+        '''
+        查询指标数据
+        
+        Args:
+            query (str): 查询语句
+            
+        Returns:
+            dict: 查询结果
+        '''
+        url = f"{self.url}/prometheus/api/v1/query"
+        r = requests.get(
+            url, 
+            timeout=self.timeout,
+            params={"query": query}
+        )
+        if r.json().get("status") == "success":
+            return ReturnResponse(code=0, msg=f"[{query}] 查询成功!", data=r.json()['data']['result'])
+        else:
+            return ReturnResponse(code=1, msg=f"[{query}] 查询失败: {r.json().get('error')}", data=r.json())

pytbox-20250818.2.dist-info/METADATA

@@ -0,0 +1,262 @@
+Metadata-Version: 2.4
+Name: pytbox
+Version: 20250818.2
+Summary: A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)
+Author-email: mingming hou <houm01@foxmail.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.0
+Requires-Dist: pydantic>=1.10
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: python-dotenv; extra == "dev"
+
+# PytBox
+
+[![PyPI version](https://img.shields.io/pypi/v/pytbox.svg)](https://pypi.org/project/pytbox/)
+[![Python version](https://img.shields.io/pypi/pyversions/pytbox.svg)](https://pypi.org/project/pytbox/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+一个集成了多种服务和实用工具的 Python 包，专为运维开发场景设计。包含 VictoriaMetrics、滴答清单(Dida365)、飞书等服务的集成工具，以及常用的时间处理等实用工具。
+
+## 特性
+
+- 🔍 **VictoriaMetrics 集成** - 提供时序数据库查询功能
+- ⏰ **时间工具** - 常用的时间戳处理工具
+- 📊 **统一响应格式** - 标准化的 API 响应结构
+- 🛠 **基础工具类** - 提供 API 基类和通用功能
+- 🧪 **完整测试** - 包含单元测试确保代码质量
+
+## 安装
+
+### 从 PyPI 安装
+
+```bash
+pip install pytbox
+```
+
+### 从源码安装
+
+```bash
+git clone https://github.com/your-username/pytbox.git
+cd pytbox
+pip install -e .
+```
+
+## 快速开始
+
+### VictoriaMetrics 查询
+
+```python
+from pytbox.victoriametrics import VictoriaMetrics
+
+# 初始化 VictoriaMetrics 客户端
+vm = VictoriaMetrics(url="http://localhost:8428", timeout=5)
+
+# 查询指标数据
+result = vm.query('ping_average_response_ms')
+
+if result.is_success():
+    print("查询成功:", result.data)
+else:
+    print("查询失败:", result.msg)
+```
+
+### 时间工具使用
+
+```python
+from pytbox.utils.timeutils import TimeUtils
+
+# 获取当前时间戳（秒）
+timestamp = TimeUtils.get_timestamp()
+print(f"当前时间戳: {timestamp}")
+
+# 获取当前时间戳（毫秒）
+timestamp_ms = TimeUtils.get_timestamp(now=False)
+print(f"当前时间戳(毫秒): {timestamp_ms}")
+```
+
+### 使用基础 API 类
+
+```python
+from pytbox.common.base import BaseAPI
+
+class MyAPI(BaseAPI):
+    def __init__(self):
+        super().__init__(base_url="https://api.example.com")
+    
+    def make_request(self):
+        # 记录请求日志
+        log = self.log_request("GET", "/users", {"param": "value"})
+        print("请求日志:", log)
+        
+        # 检查会话存活时间
+        age = self.get_session_age()
+        print(f"会话存活时间: {age} 秒")
+
+api = MyAPI()
+api.make_request()
+```
+
+### 统一响应格式
+
+```python
+from pytbox.utils.response import ReturnResponse
+
+# 创建成功响应
+success_response = ReturnResponse(
+    code=0,
+    msg="操作成功",
+    data={"user_id": 123, "username": "admin"}
+)
+
+# 创建错误响应
+error_response = ReturnResponse(
+    code=1,
+    msg="用户未找到",
+    data=None
+)
+
+# 检查响应状态
+if success_response.is_success():
+    print("操作成功:", success_response.data)
+
+if error_response.is_error():
+    print("操作失败:", error_response.msg)
+```
+
+## API 文档
+
+### VictoriaMetrics
+
+#### `VictoriaMetrics(url, timeout=3)`
+
+VictoriaMetrics 时序数据库客户端。
+
+**参数:**
+- `url` (str): VictoriaMetrics 服务器地址
+- `timeout` (int): 请求超时时间，默认 3 秒
+
+**方法:**
+
+##### `query(query: str) -> ReturnResponse`
+
+执行 PromQL 查询。
+
+**参数:**
+- `query` (str): PromQL 查询语句
+
+**返回:**
+- `ReturnResponse`: 统一响应格式，包含查询结果
+
+### TimeUtils
+
+#### `TimeUtils.get_timestamp(now=True) -> int`
+
+获取时间戳。
+
+**参数:**
+- `now` (bool): True 返回秒级时间戳，False 返回毫秒级时间戳
+
+**返回:**
+- `int`: 时间戳
+
+### ReturnResponse
+
+统一的响应格式类，包含以下状态码：
+
+- `0` - 成功 (SUCCESS)
+- `1` - 一般错误 (ERROR)
+- `2` - 警告 (WARNING)
+- `3` - 未授权 (UNAUTHORIZED)
+- `4` - 资源未找到 (NOT_FOUND)
+- `5` - 请求超时 (TIMEOUT)
+- `6` - 参数错误 (INVALID_PARAMS)
+- `7` - 权限不足 (PERMISSION_DENIED)
+- `8` - 服务不可用 (SERVICE_UNAVAILABLE)
+- `9` - 数据库错误 (DATABASE_ERROR)
+- `10` - 网络错误 (NETWORK_ERROR)
+
+**方法:**
+- `is_success() -> bool`: 判断是否为成功响应
+- `is_error() -> bool`: 判断是否为错误响应
+
+## 开发
+
+### 安装开发依赖
+
+```bash
+pip install -e ".[dev]"
+```
+
+### 运行测试
+
+```bash
+pytest tests/
+```
+
+### 代码格式化
+
+```bash
+black src/ tests/
+```
+
+### 代码检查
+
+```bash
+ruff check src/ tests/
+```
+
+## 环境变量
+
+可以通过以下环境变量进行配置：
+
+- `VICTORIAMETRICS_URL`: VictoriaMetrics 服务器地址（默认: http://localhost:8428）
+
+## 发布流程
+
+项目使用 GitHub Actions 自动发布到 PyPI：
+
+1. 更新版本号（在 `pyproject.toml` 中）
+2. 使用发布脚本创建标签：
+   ```bash
+   ./publish.sh 0.1.1
+   ```
+3. GitHub Actions 会自动构建并发布到 PyPI
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+1. Fork 项目
+2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启 Pull Request
+
+## 许可证
+
+本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
+
+## 更新日志
+
+### v0.1.0
+- 初始版本发布
+- 添加 VictoriaMetrics 集成
+- 添加时间工具类
+- 添加统一响应格式
+- 添加基础 API 工具类
+
+## 联系方式
+
+如有问题或建议，请通过以下方式联系：
+
+- 提交 [Issue](https://github.com/your-username/pytbox/issues)
+- 发送邮件至 you@example.com
+
+---
+
+**PytBox** - 让运维开发更简单！ 🚀

pytbox-20250818.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+pytbox/dida365.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytbox/timeutils.py,sha256=Nqnn8clbgv-5l0PgxcTOldg8mkMKrFn4TvPL-rYUUGg,1
+pytbox/victoriametrics.py,sha256=xYizUXeazVQM7-MT9wxhqtfol2fZrXjfrt1qRgDsTKU,1098
+pytbox/common/__init__.py,sha256=3JWfgCQZKZuSH5NCE7OCzKwq82pkyop9l7sH5YSNyfU,122
+pytbox/common/base.py,sha256=aMKLcBi0-3UEYxANolE_qInC-0ZeydMGBB803xWzorI,1291
+pytbox/utils/response.py,sha256=WAsA84VDyOTEaFl2jyGFNhAiYuoI-UHngb89AiUXD_U,1251
+pytbox/utils/timeutils.py,sha256=ebTowUmWPnv1i1YfOqJo8s1mti1gA7qonJ-qnv5S-ZE,423
+pytbox-20250818.2.dist-info/METADATA,sha256=3K7W__SsA8kgnFQVRuUPDVAq_biIuV_QikJVCb8y2sI,5926
+pytbox-20250818.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pytbox-20250818.2.dist-info/top_level.txt,sha256=YADgWue-Oe128ptN3J2hS3GB0Ncc5uZaSUM3e1rwswE,7
+pytbox-20250818.2.dist-info/RECORD,,

pytbox-20250818.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pytbox-20250818.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+pytbox