dataops-sdk 0.3.6__tar.gz → 0.4.1__tar.gz

dataops_sdk-0.4.1/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: dataops-sdk
+Version: 0.4.1
+Summary: Python SDK for the DataOps platform.
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: pydantic-core
+Requires-Dist: pydantic-settings>=2.14.2
+Requires-Dist: httpx2>=2.5.0
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: markdown-it-py[plugins]
+Requires-Dist: cryptography>=49.0.0
+Requires-Dist: PyYaml
+Provides-Extra: runner
+Requires-Dist: paramiko>4; extra == "runner"
+Requires-Dist: pandas; extra == "runner"
+Requires-Dist: sqlalchemy; extra == "runner"
+Requires-Dist: pymysql; extra == "runner"
+Requires-Dist: doris-python>=1.0.3; extra == "runner"
+Requires-Dist: oracledb~=4.0.1; extra == "runner"
+Requires-Dist: neo4j; extra == "runner"
+Requires-Dist: kafka-python>3; extra == "runner"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+
+# dataops-sdk
+
+Python SDK for the DataOps platform.
+
+## 安装
+
+```bash
+# 基础安装
+pip install dataops_sdk
+
+# 含数据库驱动
+pip install "dataops_sdk[runner]"
+```
+
+## 快速开始
+
+```python
+from dataops_sdk.session import configure
+from dataops_sdk.services import service_list_tables, service_get_table_data_by_code
+
+# 配置认证
+configure(base_url="https://your-platform.com", api_key="your-api-key")
+
+# 查询数据表
+tables = service_list_tables("doris")
+print(tables)
+```
+
+## 核心模块
+
+### session — 认证配置
+
+```python
+from dataops_sdk.session import configure, get_session
+
+configure(base_url, api_key)  # 设置全局会话
+```
+
+### schemas — 数据模型
+
+| 模块 | 说明 |
+|------|------|
+| `MetaType` | 元数据类型枚举 |
+| `SqlQueryParam` | SQL 查询参数 |
+| `Meta` | 元数据通用模型 |
+| `Datasource` | 数据源模型 |
+| `DataTable` | 数据表模型 |
+| `Dataset` | 数据集模型 |
+| `Metrics` | 指标模型 |
+| `Report` | 报表模型 |
+| `Widget` | 组件模型 |
+| `Workflow` | 工作流模型 |
+| `Alarm` | 告警模型 |
+| `Hazard` | 隐患模型 |
+| `Api` | API 模型 |
+| `Dict` | 字典模型 |
+| `Skill` | 技能模型 |
+| `Ref` | 引用模型 |
+
+### services — 平台操作
+
+每个服务模块对应一类实体的操作，提供 `list`、`detail` 等通用接口：
+
+- `service_*_list` — 列表查询
+- `service_*_detail` — 详情查询
+- `service_*_create` — 创建
+- `service_*_update` — 更新
+- `service_*_delete` — 删除
+
+## 依赖
+
+- Python >= 3.11
+- pydantic >= 2
+- httpx2 >= 2.5.0
+- pydantic-settings >= 2.14.2
+- jinja2 >= 3.1.6
+- cryptography >= 49.0.0
+
+## 可选依赖 (runner)
+
+- paramiko > 4 — 文件传输
+- pandas — 数据分析
+- sqlalchemy / pymysql / doris-python / oracledb — 关系数据库
+- neo4j — 图数据库
+- kafka-python > 3 — 队列驱动

dataops_sdk-0.4.1/README.md

@@ -0,0 +1,85 @@
+# dataops-sdk
+
+Python SDK for the DataOps platform.
+
+## 安装
+
+```bash
+# 基础安装
+pip install dataops_sdk
+
+# 含数据库驱动
+pip install "dataops_sdk[runner]"
+```
+
+## 快速开始
+
+```python
+from dataops_sdk.session import configure
+from dataops_sdk.services import service_list_tables, service_get_table_data_by_code
+
+# 配置认证
+configure(base_url="https://your-platform.com", api_key="your-api-key")
+
+# 查询数据表
+tables = service_list_tables("doris")
+print(tables)
+```
+
+## 核心模块
+
+### session — 认证配置
+
+```python
+from dataops_sdk.session import configure, get_session
+
+configure(base_url, api_key)  # 设置全局会话
+```
+
+### schemas — 数据模型
+
+| 模块 | 说明 |
+|------|------|
+| `MetaType` | 元数据类型枚举 |
+| `SqlQueryParam` | SQL 查询参数 |
+| `Meta` | 元数据通用模型 |
+| `Datasource` | 数据源模型 |
+| `DataTable` | 数据表模型 |
+| `Dataset` | 数据集模型 |
+| `Metrics` | 指标模型 |
+| `Report` | 报表模型 |
+| `Widget` | 组件模型 |
+| `Workflow` | 工作流模型 |
+| `Alarm` | 告警模型 |
+| `Hazard` | 隐患模型 |
+| `Api` | API 模型 |
+| `Dict` | 字典模型 |
+| `Skill` | 技能模型 |
+| `Ref` | 引用模型 |
+
+### services — 平台操作
+
+每个服务模块对应一类实体的操作，提供 `list`、`detail` 等通用接口：
+
+- `service_*_list` — 列表查询
+- `service_*_detail` — 详情查询
+- `service_*_create` — 创建
+- `service_*_update` — 更新
+- `service_*_delete` — 删除
+
+## 依赖
+
+- Python >= 3.11
+- pydantic >= 2
+- httpx2 >= 2.5.0
+- pydantic-settings >= 2.14.2
+- jinja2 >= 3.1.6
+- cryptography >= 49.0.0
+
+## 可选依赖 (runner)
+
+- paramiko > 4 — 文件传输
+- pandas — 数据分析
+- sqlalchemy / pymysql / doris-python / oracledb — 关系数据库
+- neo4j — 图数据库
+- kafka-python > 3 — 队列驱动

{dataops_sdk-0.3.6 → dataops_sdk-0.4.1}/pyproject.toml

@@ -7,6 +7,7 @@ name = "dataops-sdk"
 dynamic = ["version"]
 description = "Python SDK for the DataOps platform."
 requires-python = ">=3.11"
+readme = "README.md"
 dependencies = [
     "pydantic>=2,<3",
     "pydantic-core",

{dataops_sdk-0.3.6 → dataops_sdk-0.4.1}/src/dataops_sdk/__init__.py

@@ -107,4 +107,4 @@ from .services import (  # noqa: F401
 )
 from .session import dataops_base_url_context, request_context
 
-__version__ = "0.3.6"
+__version__ = "0.4.1"

{dataops_sdk-0.3.6 → dataops_sdk-0.4.1}/src/dataops_sdk/runner/utils/__init__.py

@@ -19,7 +19,14 @@ Example:
     >>> from dataops_sdk.runner.utils import DatabaseConn, encrypt_body
 """
 
-from .common import decrypt_body, encrypt_body, generate_uuid, parse_args, print_json
+from .common import (
+    decrypt_body,
+    encrypt_body,
+    generate_uuid,
+    parse_args,
+    parse_trigger_time,
+    print_json,
+)
 from .dbConn_sync import DatabaseConn
 from .ftp_file_transfer import FTPFileTransfer
 from .nacos import get_service_instance
@@ -39,4 +46,5 @@ __all__ = [
     "FTPFileTransfer",
     "SFTPFileTransfer",
     "parse_args",
+    "parse_trigger_time",
 ]

{dataops_sdk-0.3.6 → dataops_sdk-0.4.1}/src/dataops_sdk/schemas/__init__.py

@@ -14,11 +14,21 @@ from .alarm import (
     AlarmSpecItem,
 )
 from .api import ApiMeta, HttpInterfaceData
+from .common import DataOpsResponse
 from .data_table import DataTableData, MetaDataTable
 from .datasource import DataDataSource
 from .dict_ import DataDict, DictItem
-from .enums import InnerMetaType, MetaType
-from .group import GroupNode
+from .enums import (
+    GroupNodeRefType,
+    InnerMetaType,
+    MetaReportSubType,
+    MetaSkillFileSubType,
+    MetaSkillSubType,
+    MetaTemplateSubType,
+    MetaType,
+    MetaWidgetSubType,
+)
+from .group import GroupNode, GroupTree
 from .hazard import HazardRecordDTO, HazardTaskDTO
 from .meta import (
     DEFAULT_META_DATA_TYPE,
@@ -26,11 +36,11 @@ from .meta import (
     Meta,
     MetaBase,
     MetaCreate,
+    MetaPageData,
     MetaRef,
     MetaUpdate,
-    MetaPageData,
 )
-from .query import PageParam, SqlCondition, SqlQueryParam, SqlSort
+from .query import PageParam, SqlCondition, SqlFilter, SqlQueryParam, SqlSort
 from .report import ReportMeta, ReportMetaData
 from .skill import DataSkill, DataSkillSubFile, MetaSkill, SkillCallResult
 from .table import (
@@ -44,4 +54,3 @@ from .table import (
 from .user import Application, UserInfo
 from .widget import WidgetMeta, WidgetMetaData
 from .workflow import DataWorkflow, MetaWorkflow
-from .common import DataOpsResponse

dataops_sdk-0.4.1/src/dataops_sdk/schemas/common.py

@@ -0,0 +1,11 @@
+from typing import Annotated, Generic, TypeVar
+
+from pydantic import BaseModel, Field, JsonValue, NonNegativeInt
+
+DataVar = TypeVar("DataVar")
+
+
+class DataOpsResponse(BaseModel, Generic[DataVar]):
+    code: Annotated[NonNegativeInt, Field(description="响应码")]
+    msg: Annotated[str | None, Field(description="响应消息")]
+    data: Annotated[DataVar, Field(description="响应数据")]

{dataops_sdk-0.3.6 → dataops_sdk-0.4.1}/src/dataops_sdk/schemas/data_table.py

@@ -410,7 +410,7 @@ class DataTableField(BaseModel):
 
     title: Annotated[str | None, Field(description="显示标题")]
     name: Annotated[str, Field(description="字段名称/列名 (前端显示的名称)")]
-    type: Annotated[str, Field(description="字段类型")]
+    type: Annotated[str | None, Field(description="字段类型")] = None
 
     # 数据属性
     pk: Annotated[bool, Field(description="是否主键")] = False
@@ -608,7 +608,7 @@ class DataTableData(BaseModel):
     """
 
     # 模型配置
-    model: Annotated[DataTableModel, Field(description="数据源模型配置")]
+    model: Annotated[DataTableModel | None, Field(description="数据源模型配置")] = None
 
     # 字段定义
     fields: Annotated[list[DataTableField], Field(description="字段列表", default_factory=list)] = (
@@ -641,6 +641,8 @@ class DataTableData(BaseModel):
     querys: Annotated[list[QueryCondition] | None, Field(description="查询条件列表")] = None
     query_form: Annotated[QueryForm | None, Field(description="查询表单配置")] = None
 
+    model_config = ConfigDict(extra="allow")
+
 
 # ---------------------------------------------------------------------------
 # MetaDataTable

{dataops_sdk-0.3.6 → dataops_sdk-0.4.1}/src/dataops_sdk/schemas/enums.py

@@ -7,6 +7,14 @@
 from enum import StrEnum
 
 
+class GroupNodeRefType(StrEnum):
+    """分组节点引用类型枚举."""
+
+    INNER = "inner"
+    BEFORE = "before"
+    AFTER = "after"
+
+
 class InnerMetaType(StrEnum):
     """SDK 内部使用的 Meta 类型枚举.
 
@@ -16,8 +24,11 @@ class InnerMetaType(StrEnum):
         DATASOURCE: 数据源类型 meta。
     """
 
+    GROUP = "group"
+    """分组"""
+
     DATASOURCE = "datasource"
-    """数据源类型 meta。"""
+    """数据源类型"""
 
     def __repr__(self):
         return self.value
@@ -76,17 +87,17 @@ class SqlExpression(StrEnum):
     用于查询条件构造，对应后端 ``SqlExpression``。
     """
 
-    EQ = "="
+    EQ = "eq"
     """相等 (=)。"""
-    NE = "!="
+    NE = "ne"
     """不相等 (!=)。"""
-    GT = ">"
+    GT = "gt"
     """大于 (>)。"""
-    GE = ">="
+    GE = "ge"
     """大于等于 (>=)。"""
-    LT = "<"
+    LT = "lt"
     """小于 (<)。"""
-    LE = "<="
+    LE = "le"
     """小于等于 (<=)。"""
     IN = "in"
     """属于 (IN)。"""
@@ -116,16 +127,16 @@ class SqlExpression(StrEnum):
         Returns:
             str: 中文标题，例如 ``"相等"``、``"属于"`` 等。
         """
-        return _EXPRESSION_TITLES[self]
+        return _EXPRESSION_TITLES[self.value]
 
 
 _EXPRESSION_TITLES: dict[str, str] = {
-    "=": "相等",
-    "!=": "不相等",
-    ">": "大于",
-    ">=": "大于等于",
-    "<": "小于",
-    "<=": "小于等于",
+    "eq": "相等",
+    "ne": "不相等",
+    "gt": "大于",
+    "ge": "大于等于",
+    "lt": "小于",
+    "le": "小于等于",
     "in": "属于",
     "notin": "不属于",
     "like": "匹配",
@@ -209,3 +220,55 @@ class ColumnType(StrEnum):
     """子表类型。"""
     STRING = "string"
     """字符串类型。"""
+
+
+class MetaWidgetSubType(StrEnum):
+    """卡片子类型枚举."""
+
+    CHART = "chart"
+    TABLE = "table"
+    DETAIL = "detail"
+    STATISTIC = "statistic"
+    STATISTIC_V2 = "statistic-v2"
+    GIS = "gis"
+    METRIC = "metric"
+    TOPOLOGY = "topology"
+    AMIS = "amis"
+
+
+class MetaTemplateSubType(StrEnum):
+    """模板子类型枚举."""
+
+    REPORT = "report"
+    PYTHON = "python"
+    JAVASCRIPT = "javascript"
+
+
+class MetaSkillSubType(StrEnum):
+    """技能子类型枚举."""
+
+    LLM = "llm"
+    API = "api"
+    REPORT = "report"
+    FORM_SAVE = "form-save"
+
+
+class MetaSkillFileSubType(StrEnum):
+    """技能子文件类型枚举."""
+
+    DOC = "doc"
+    CODE = "code"
+    IMAGE = "image"
+
+
+class MetaReportSubType(StrEnum):
+    """文档子类型枚举."""
+
+    # 文档
+    DOC = "doc"
+    # 本体
+    ONTOLOGY = "ontology"
+    # 看板
+    DASHBOARD = "dashboard"
+    # # 废弃
+    # SKILL = "skill"

dataops_sdk-0.4.1/src/dataops_sdk/schemas/group.py

@@ -0,0 +1,66 @@
+"""分组节点 (GroupNode) Schema 定义.
+
+用于表示数据源目录树中的分组节点，包含节点的基本信息
+和层级关系。
+"""
+
+from typing import Annotated
+
+from pydantic import AliasChoices, BaseModel, Field, JsonValue
+
+
+class GroupTree(BaseModel):
+    prodCode: Annotated[
+        str,
+        Field(
+            description="产品编码",
+            validation_alias=AliasChoices("prodCode", "prod_code", "PROD_CODE"),
+        ),
+    ]
+    release: Annotated[
+        str | None, Field(description="版本", validation_alias=AliasChoices("release", "RELEASE"))
+    ] = None
+
+    name: Annotated[str, Field(description="名称", validation_alias=AliasChoices("name", "NAME"))]
+    title: Annotated[
+        str, Field(description="中文名称", validation_alias=AliasChoices("title", "TITLE"))
+    ]
+
+    data: list["GroupNode"] = Field(default_factory=list, description="数据")
+    nodeMap: dict[str, dict[str, JsonValue]] = Field(default_factory=dict, description="节点映射")
+
+
+class GroupNode(BaseModel):
+    id: Annotated[
+        str, Field(description="元数据ID", validation_alias=AliasChoices("id", "cuid", "CUID"))
+    ]
+    pid: Annotated[str | None, Field(description="父ID")]
+    parentId: Annotated[
+        str | None,
+        Field(
+            description="父ID", validation_alias=AliasChoices("parentId", "parent_id", "PARENT_ID")
+        ),
+    ]
+
+    type: Annotated[str, Field(description="类型", validation_alias=AliasChoices("type", "TYPE"))]
+    subType: Annotated[
+        str | None,
+        Field(
+            description="子类型", validation_alias=AliasChoices("subType", "sub_type", "SUB_TYPE")
+        ),
+    ]
+
+    name: Annotated[str, Field(description="名称", validation_alias=AliasChoices("name", "NAME"))]
+    title: Annotated[
+        str, Field(description="中文名称", validation_alias=AliasChoices("label", "title", "TITLE"))
+    ]
+    digest: Annotated[
+        str | None, Field(description="摘要", validation_alias=AliasChoices("digest", "DIGEST"))
+    ]
+    remark: Annotated[
+        str | None, Field(description="备注", validation_alias=AliasChoices("remark", "REMARK"))
+    ]
+
+    attrs: Annotated[dict[str, JsonValue] | None, Field(description="扩展属性")] = None
+    params: Annotated[dict[str, JsonValue] | None, Field(description="参数")] = None
+    children: Annotated[list["GroupNode"] | None, Field(description="子节点")] = None

{dataops_sdk-0.3.6 → dataops_sdk-0.4.1}/src/dataops_sdk/schemas/meta.py

@@ -127,7 +127,10 @@ class MetaBase(BaseModel):
     ] = None
     spaceName: Annotated[
         str | None,
-        Field(description="空间名称", validation_alias=AliasChoices("spaceName", "space_name", "SPACE_NAME")),
+        Field(
+            description="空间名称",
+            validation_alias=AliasChoices("spaceName", "space_name", "SPACE_NAME"),
+        ),
     ] = None
 
     subSystem: Annotated[
@@ -340,6 +343,10 @@ class MetaUpdate(BaseModel, Generic[META_DATA_TYPE]):
 
 class MetaPageData(BaseModel):
     total: Annotated[int, Field(description="总数")]
-    page_num: Annotated[int, Field(description="页码", validation_alias=AliasChoices("pageNum", "page_num"))]
-    page_size: Annotated[int, Field(description="页大小", validation_alias=AliasChoices("pageSize", "page_size"))]
+    page_num: Annotated[
+        int, Field(description="页码", validation_alias=AliasChoices("pageNum", "page_num"))
+    ]
+    page_size: Annotated[
+        int, Field(description="页大小", validation_alias=AliasChoices("pageSize", "page_size"))
+    ]
     records: list[MetaBase] = Field(default_factory=list, description="数据")