pytbox 0.0.1__py3-none-any.whl

pytbox/victorialog.py

@@ -0,0 +1,125 @@
+
+ 
+from typing import Literal
+import requests
+import time
+from .utils.response import ReturnResponse
+from .utils.timeutils import TimeUtils
+
+
+
+class Victorialog:
+    '''
+    _summary_
+    '''
+    def __init__(self, url: str=None, timeout: int=3):
+        self.url = url
+        self.timeout = timeout
+
+    def send_program_log(self, 
+             stream: str='inbox',
+             date: str = None,
+             level: Literal['INFO', 'DEBUG', 'WARNING', 'ERROR', 'CRITICAL', 'SUCCESS'] = 'INFO',
+             message: str = "test",
+             app_name: str = "test",
+             file_name: str = None,
+             line_number: int = None,
+             function_name: str = None
+        ) -> ReturnResponse:
+        
+        # 如果没有提供timestamp，自动生成ISO 8601格式的UTC时间
+        if date is None:
+            date = TimeUtils.get_utc_time()
+        
+        if not isinstance(message, str):
+            try:
+                message = str(message)
+            except Exception:
+                message = "message 无法转换为字符串"
+        
+        r = requests.post(
+            url=self.url + '/insert/jsonline?_stream_fields=stream&_time_field=date&_msg_field=log.message',
+            headers={'Content-Type': 'application/stream+json'},
+            json={
+                "log": {
+                    "level": level, 
+                    "message": message,
+                    "app": app_name,
+                    "file": file_name,
+                    "line": line_number,
+                    "function": function_name
+                },
+                "date": date, 
+                "stream": stream
+            },
+            timeout=self.timeout
+        )
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg=f"{message} 发送成功", data=r.text)
+        else:
+            return ReturnResponse(code=1, msg=f"{message} 发送失败")
+    
+    def send_syslog(self, stream, hostname, ip, level, message, date):
+
+        # 如果没有提供timestamp，自动生成ISO 8601格式的UTC时间
+        if date is None:
+            date = TimeUtils.get_utc_time()
+        
+        r = requests.post(
+            url=self.url,
+            headers={'Content-Type': 'application/stream+json'},
+            json={
+                "log": {
+                    "hostname": hostname,
+                    "ip": ip,
+                    "level": level, 
+                    "message": message,
+                },
+                "date": date, 
+                "stream": stream
+            },
+            timeout=self.timeout
+        )
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg=f"{message} 发送成功", data=r.text)
+        else:
+            return ReturnResponse(code=1, msg=f"{message} 发送失败")
+
+    def query(self, query: str=None, delay: int=0) -> ReturnResponse:
+        """
+        查询日志数据
+        
+        Args:
+            query: 查询语句
+            limit: 限制返回结果数量
+            **kwargs: 其他表单参数，如 start_time, end_time 等
+            
+        Returns:
+            dict: 响应数据
+        """
+        
+        # 构建查询URL
+        query_url = f"{self.url}/select/logsql/query"
+        
+        # 构建表单数据
+        form_data = {'query': query}
+        if delay > 0:
+            time.sleep(delay)
+        # 发送POST请求，data参数传递多个表单数据
+        response = requests.post(
+            url=query_url,
+            # headers={'Content-Type': 'application/stream+json'},
+            data=form_data,  # 使用data参数传递多个表单数据
+            timeout=self.timeout
+        )
+        if response.status_code == 200:
+            if len(response.text) > 0:
+                return ReturnResponse(code=0, message=f"{form_data} 查询成功", data=response.text)
+            else:
+                return ReturnResponse(code=2, message=f"{form_data} 查询成功, 但没有数据")
+        else:
+            return ReturnResponse(code=1, message=f"{form_data} 查询失败")
+
+if __name__ == "__main__":
+    victorialog = Victorialog()
+    pass

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-0.0.1.dist-info/METADATA

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: pytbox
+Version: 0.0.1
+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
+Requires-Dist: onepassword>=1.0.0
+Requires-Dist: onepasswordconnectsdk>=1.0.0
+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)
+- 发送邮件至 houm01@foxmail.com
+
+---
+
+**PytBox** - 让运维开发更简单！ 🚀

pytbox-0.0.1.dist-info/RECORD

@@ -0,0 +1,21 @@
+pytbox/dida365.py,sha256=s6ipeweXMV3CaatFFwuxEwBLGK9jJ0B6GP7dQMYxpDo,10592
+pytbox/logger.py,sha256=4IHmMg14Rwekmc7AeKGDbsDZryhcD6elaJZsvpdYJ80,5659
+pytbox/onepassword_connect.py,sha256=nD3xTl1ykQ4ct_dCRRF138gXCtk-phPfKYXuOn-P7Z8,3064
+pytbox/onepassword_sa.py,sha256=08iUcYud3aEHuQcUsem9bWNxdXKgaxFbMy9yvtr-DZQ,6995
+pytbox/victorialog.py,sha256=50cVPxq9PzzzkzQHhgv_785K3GeF8B2mEnChdeekZWU,4137
+pytbox/victoriametrics.py,sha256=xYizUXeazVQM7-MT9wxhqtfol2fZrXjfrt1qRgDsTKU,1098
+pytbox/alicloud/sls.py,sha256=WZuxt6NjY3Sf9KMF4DoDlCoxbdqGL2lyymp6jQW-wJc,4355
+pytbox/common/__init__.py,sha256=3JWfgCQZKZuSH5NCE7OCzKwq82pkyop9l7sH5YSNyfU,122
+pytbox/common/base.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytbox/feishu/client.py,sha256=kwGLseGT_iQUFmSqpuS2_77WmxtHstD64nXvktuQ3B4,5865
+pytbox/feishu/endpoints.py,sha256=z_nHGXAjlIyYdFnbAWY4hfzzHrENJvoNOqY9sA6-FLk,40009
+pytbox/feishu/errors.py,sha256=79qFAHZw7jDj3gnWAjI1-W4tB0q1_aSfdjee4xzXeuI,1179
+pytbox/feishu/helpers.py,sha256=jhSkHiUw4822QBXx2Jw8AksogZdakZ-3QqvC3lB3qEI,201
+pytbox/feishu/typing.py,sha256=3hWkJgOi-v2bt9viMxkyvNHsPgrbAa0aZOxsZYg2vdM,122
+pytbox/utils/env.py,sha256=jO_-BKbGuDU7lIL9KYkcxGCzQwTXfxD4mIYtSAjREmI,622
+pytbox/utils/response.py,sha256=WAsA84VDyOTEaFl2jyGFNhAiYuoI-UHngb89AiUXD_U,1251
+pytbox/utils/timeutils.py,sha256=zMf6Oe7dc5oR-yyvMxznq8Jr78S_WRVmhg-Z7hJdypQ,979
+pytbox-0.0.1.dist-info/METADATA,sha256=aDRXMGyuwmnzJUjz1WGhGJU-VSXepcAnpvbrlWiZri0,6002
+pytbox-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pytbox-0.0.1.dist-info/top_level.txt,sha256=YADgWue-Oe128ptN3J2hS3GB0Ncc5uZaSUM3e1rwswE,7
+pytbox-0.0.1.dist-info/RECORD,,

pytbox-0.0.1.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-0.0.1.dist-info/top_level.txt

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