xmes-dingtalk-connectflow-sdk 1.0.0__tar.gz

xmes_dingtalk_connectflow_sdk-1.0.0/LICENSE

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

xmes_dingtalk_connectflow_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: xmes-dingtalk-connectflow-sdk
+Version: 1.0.0
+Summary: DingTalk Connection Platform Connection Flow SDK
+License: MIT
+Author: leslieliang
+Author-email: zwliang98@163.com
+Requires-Python: >=3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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-Dist: requests (>=2.32.3,<3.0.0)
+Description-Content-Type: text/markdown
+
+## 概述
+![Version](https://img.shields.io/badge/Version-v1.0.0-green)
+![Python Version](https://img.shields.io/badge/Python-%E2%89%A53.9-blue)
+
+`xmes-dingtalk-connectflow-sdk` 是钉钉连接平台自建连接流SDK（向美而生），通过该工具可以方便快捷的调用钉钉的连接流。
+
+## 安装使用
+```bash
+pip install xmes-dingtalk-connectflow-sdk
+```
+
+## 功能特征
+- 支持连接流 `多维表CURD_241217`
+
+## 使用方法
+### ComplexTable
+该工具提供了连接流 `多维表CURD_241217` 的操作调用工具。
+```python
+from DingtalkConnectflowSDK import ComplexTable, GetterFilter, Updater
+
+# 初始化ComplexTable对象
+complextable = ComplexTable(flow_url='<连接流的同步协调URL>')
+
+# 获取 Table 对象
+table = complextable.get_table(did='<文档ID>', tid='<数据表ID>')
+
+# 查询数据
+filters = [
+    GetterFilter(field='来源', operator='equal', value=['SDK', 'API'])
+]
+resp = table.get(size=10, fillters=filters)
+
+# 新增数据
+records = [
+    {'标题': 'Test Record 1', '来源': 'SDK},
+    {'标题': 'Test Record 2', '来源': 'SDK},
+]
+resp = table.add(records)
+
+# 更新数据
+records = [
+    Updater(record_id='<记录ID>', fields={'来源': 'API'}),
+    Updater(record_id='<记录ID>', fields={'来源': 'API'}),
+]
+resp = table.update(records)
+
+# 删除数据
+record_ids = ['<记录ID>', '<记录ID>']
+resp = table.delete(record_ids)
+```

xmes_dingtalk_connectflow_sdk-1.0.0/README.md

@@ -0,0 +1,50 @@
+## 概述
+![Version](https://img.shields.io/badge/Version-v1.0.0-green)
+![Python Version](https://img.shields.io/badge/Python-%E2%89%A53.9-blue)
+
+`xmes-dingtalk-connectflow-sdk` 是钉钉连接平台自建连接流SDK（向美而生），通过该工具可以方便快捷的调用钉钉的连接流。
+
+## 安装使用
+```bash
+pip install xmes-dingtalk-connectflow-sdk
+```
+
+## 功能特征
+- 支持连接流 `多维表CURD_241217`
+
+## 使用方法
+### ComplexTable
+该工具提供了连接流 `多维表CURD_241217` 的操作调用工具。
+```python
+from DingtalkConnectflowSDK import ComplexTable, GetterFilter, Updater
+
+# 初始化ComplexTable对象
+complextable = ComplexTable(flow_url='<连接流的同步协调URL>')
+
+# 获取 Table 对象
+table = complextable.get_table(did='<文档ID>', tid='<数据表ID>')
+
+# 查询数据
+filters = [
+    GetterFilter(field='来源', operator='equal', value=['SDK', 'API'])
+]
+resp = table.get(size=10, fillters=filters)
+
+# 新增数据
+records = [
+    {'标题': 'Test Record 1', '来源': 'SDK},
+    {'标题': 'Test Record 2', '来源': 'SDK},
+]
+resp = table.add(records)
+
+# 更新数据
+records = [
+    Updater(record_id='<记录ID>', fields={'来源': 'API'}),
+    Updater(record_id='<记录ID>', fields={'来源': 'API'}),
+]
+resp = table.update(records)
+
+# 删除数据
+record_ids = ['<记录ID>', '<记录ID>']
+resp = table.delete(record_ids)
+```

xmes_dingtalk_connectflow_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[tool.poetry]
+name = "xmes-dingtalk-connectflow-sdk"
+version = "1.0.0"
+description = "DingTalk Connection Platform Connection Flow SDK"
+authors = ["leslieliang <zwliang98@163.com>"]
+license = "MIT"
+readme = "README.md"
+packages = [{ include = "DingtalkConnectflowSDK", from = "src" }]
+
+[tool.poetry.dependencies]
+python = ">=3.9"
+requests = "^2.32.3"
+
+[[tool.poetry.source]]
+name = "tsinghua"
+url = "https://pypi.tuna.tsinghua.edu.cn/simple"
+priority = "primary"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

xmes_dingtalk_connectflow_sdk-1.0.0/src/DingtalkConnectflowSDk/__init__.py

@@ -0,0 +1,3 @@
+__version__ = '1.0.0'
+
+from .complex_table import *  # noqa: F403

xmes_dingtalk_connectflow_sdk-1.0.0/src/DingtalkConnectflowSDk/complex_table.py

@@ -0,0 +1,193 @@
+"""
+Copyright (c) 2024-now LeslieLiang All rights reserved.
+Build Date: 2024-12-18
+Author: LeslieLiang
+Description: 多维表连接流SDK
+"""
+
+from dataclasses import dataclass
+from typing import Literal
+
+from requests import post
+
+
+@dataclass
+class GetterFilter:
+    field: str
+    operator: Literal[
+        'equal', 'notEqual', 'incontain', 'notContain', 'empty', 'notEmpty'
+    ]
+    value: list[str] = None
+
+
+@dataclass
+class Updater:
+    record_id: str
+    fields: dict[str, any]
+
+
+class Table:
+    __HEADERS = {
+        'Content-Type': 'application/json',
+    }
+
+    def __init__(self, flow_url: str, did: str, tid: str):
+        self.flow_url = flow_url
+        self.did = did
+        self.tid = tid
+        self.global_reqdata = {
+            'did': did,
+            'tid': tid,
+        }
+
+    def get(
+        self,
+        size=20,
+        cursor: str = '',
+        combination: Literal['and', 'or'] = 'and',
+        filters: list[GetterFilter] | None = None,
+    ) -> dict:
+        """
+        获取表格数据
+        Args:
+            size: 每页数据条数, 默认为 20
+            cursor: 分页游标, 首次请求可不传, 后续需传入上一次返回的 nextCursor 值
+            combination: 组合方式
+            filters: 过滤条件
+        Returns:
+            表格数据
+        """
+
+        reqdata = {
+            **self.global_reqdata,
+            'handle': 'GET',
+            'handle_get': {
+                'size': size,
+                'cursor': cursor,
+            },
+        }
+
+        if combination and combination in ['and', 'or']:
+            filter_field = {}
+            filter_field['combination'] = combination
+            if filters and isinstance(filters, list):
+                conditions = [
+                    item.__dict__ for item in filters if isinstance(item, GetterFilter)
+                ]
+                filter_field['conditions'] = conditions
+            reqdata['handle_get']['filter'] = filter_field
+
+        resp = post(self.flow_url, json=reqdata, headers=self.__HEADERS)
+        return resp.json().get('GET_RESULT')
+
+    def add(self, records: list[dict]):
+        """
+        新增记录
+        Args:
+            records: 新增记录列表
+        Returns:
+            新增记录结果
+        """
+
+        if not records or not isinstance(records, list):
+            raise ValueError('records must be a list')
+
+        records_clean = [
+            record for record in records if record and isinstance(record, dict)
+        ]
+        if not records_clean:
+            raise ValueError('records must not be empty')
+
+        reqdata = {
+            **self.global_reqdata,
+            'handle': 'ADD',
+            'handle_add': {
+                'records': records_clean,
+            },
+        }
+
+        resp = post(self.flow_url, json=reqdata, headers=self.__HEADERS)
+        return resp.json().get('ADD_RESULT')
+
+    def update(self, records: list[Updater]):
+        """
+        更新记录
+        Args:
+            records: 更新记录列表
+        Returns:
+            更新记录结果
+        """
+
+        if not records or not isinstance(records, list):
+            raise ValueError('records must be a list')
+
+        records_clean = [
+            record.__dict__
+            for record in records
+            if record and isinstance(record, Updater)
+        ]
+        if not records_clean:
+            raise ValueError('records must not be empty')
+
+        reqdata = {
+            **self.global_reqdata,
+            'handle': 'UPDATE',
+            'handle_update': {
+                'records': records_clean,
+            },
+        }
+
+        resp = post(self.flow_url, json=reqdata, headers=self.__HEADERS)
+        return resp.json().get('UPDATE_RESULT')
+
+    def delete(self, record_ids: list[str]):
+        """
+        删除记录
+        Args:
+            record_ids: 记录 id 列表
+        Returns:
+            删除记录结果
+        """
+
+        if not record_ids or not isinstance(record_ids, list):
+            raise ValueError('record_ids must be a list')
+
+        record_ids_clean = [
+            record_id
+            for record_id in record_ids
+            if record_id and isinstance(record_id, str)
+        ]
+
+        reqdata = {
+            **self.global_reqdata,
+            'handle': 'DELETE',
+            'handle_delete': {
+                'record_ids': record_ids_clean,
+            },
+        }
+
+        resp = post(self.flow_url, json=reqdata, headers=self.__HEADERS)
+        return resp.json().get('DELETE_RESULT')
+
+
+class ComplexTable:
+    def __init__(self, flow_url: str):
+        """
+        初始化 ComplexTable 类
+        Args:
+            flow_url: 连接流 url
+        """
+
+        self.flow_url = flow_url
+
+    def get_table(self, did: str, tid: str) -> Table:
+        """
+        获取表格对象
+        Args:
+            did: 文档 id
+            tid: 数据表 id
+        Returns:
+            Table 对象
+        """
+
+        return Table(self.flow_url, did, tid)