dootask-tools 1.0.0__py3-none-any.whl

client.py

@@ -0,0 +1,443 @@
+"""
+DooTask Tools 客户端
+"""
+
+import json
+import time
+from typing import Optional, List, Dict, Any, Union, TypeVar, Type
+from datetime import datetime, timedelta
+from dataclasses import asdict, is_dataclass
+from urllib.parse import urlencode, quote
+
+import requests
+
+from models import *
+from exceptions import *
+
+T = TypeVar('T')
+
+class DooTaskClient:
+    """DooTask 客户端"""
+    
+    def __init__(self, token: str, server: str = "http://nginx", timeout: int = 10):
+        """
+        初始化客户端
+        
+        Args:
+            token: 认证令牌
+            server: 服务器地址
+            timeout: 请求超时时间（秒）
+        """
+        self.token = token
+        self.server = server.rstrip('/')
+        self.timeout = timeout
+        self._cache: Dict[str, Dict[str, Any]] = {}
+        self._cache_time = 600  # 10分钟缓存
+        
+        # 创建会话
+        self.session = requests.Session()
+        self.session.headers.update({
+            'Token': token,
+            'User-Agent': 'DooTask-Tools/1.0',
+            'Content-Type': 'application/json'
+        })
+    
+    def _build_url(self, base_url: str, params: Optional[Dict[str, Any]] = None) -> str:
+        """构建带查询参数的URL"""
+        if not params:
+            return base_url
+        
+        query_params = []
+        for key, value in params.items():
+            if value is None:
+                continue
+            
+            if isinstance(value, bool):
+                query_params.append(f"{key}={1 if value else 0}")
+            elif isinstance(value, str):
+                if value:
+                    query_params.append(f"{key}={quote(value)}")
+            elif isinstance(value, (int, float)):
+                query_params.append(f"{key}={value}")
+            elif isinstance(value, list):
+                for item in value:
+                    if isinstance(item, str):
+                        query_params.append(f"{key}[]={quote(item)}")
+                    else:
+                        query_params.append(f"{key}[]={item}")
+            else:
+                query_params.append(f"{key}={quote(str(value))}")
+        
+        if not query_params:
+            return base_url
+        
+        separator = "&" if "?" in base_url else "?"
+        return base_url + separator + "&".join(query_params)
+    
+    def _dataclass_to_dict(self, obj: Any) -> Dict[str, Any]:
+        """将数据类转换为字典"""
+        if obj is None:
+            return {}
+        
+        if is_dataclass(obj):
+            return asdict(obj)
+        
+        if isinstance(obj, dict):
+            return obj
+        
+        # 如果是普通对象，尝试转换为字典
+        if hasattr(obj, '__dict__'):
+            return obj.__dict__
+        
+        return {}
+    
+    def _make_request(self, method: str, api: str, request_data: Any = None, 
+                      response_type: Optional[Type[T]] = None, 
+                      headers: Optional[Dict[str, Any]] = None) -> Optional[T]:
+        """发送请求"""
+        url = self.server + api
+        
+        # 设置请求头
+        request_headers = self.session.headers.copy()
+        if headers:
+            request_headers.update(headers)
+        
+        # 处理请求数据
+        if method.upper() == 'GET':
+            # GET 请求：将数据作为查询参数
+            if request_data:
+                params = self._dataclass_to_dict(request_data)
+                url = self._build_url(url, params)
+            
+            response = self.session.get(url, timeout=self.timeout)
+        
+        elif method.upper() in ['POST', 'PUT', 'PATCH']:
+            # POST/PUT/PATCH 请求：将数据作为 JSON body
+            json_data = None
+            if request_data:
+                json_data = self._dataclass_to_dict(request_data)
+            
+            response = self.session.request(
+                method, url, json=json_data, 
+                headers=request_headers, timeout=self.timeout
+            )
+        
+        elif method.upper() == 'DELETE':
+            # DELETE 请求：支持查询参数
+            if request_data:
+                params = self._dataclass_to_dict(request_data)
+                url = self._build_url(url, params)
+            
+            response = self.session.delete(url, timeout=self.timeout)
+        
+        else:
+            raise DooTaskException(f"不支持的 HTTP 方法: {method}")
+        
+        # 检查 HTTP 状态码
+        if response.status_code != 200:
+            raise DooTaskHTTPException(
+                f"HTTP {response.status_code}: {response.reason}, body: {response.text}",
+                response.status_code
+            )
+        
+        # 解析响应
+        try:
+            api_response = response.json()
+        except (json.JSONDecodeError, ValueError):
+            raise DooTaskException("响应不是有效的 JSON 格式")
+        
+        # 检查业务状态
+        if api_response.get('ret') != 1:
+            error_msg = api_response.get('msg', f"API 错误: {api_response.get('ret', 'unknown')}")
+            raise DooTaskAPIException(error_msg, api_response.get('ret', 0))
+        
+        # 如果不需要响应数据，直接返回 None
+        if response_type is None:
+            return None
+        
+        # 解析数据到目标类型
+        data = api_response.get('data')
+        if data is None:
+            return None
+        
+        # 如果是原始类型，直接返回
+        if response_type in [str, int, float, bool, dict, list]:
+            return data
+        
+        # 如果是数据类，进行转换
+        if is_dataclass(response_type):
+            if isinstance(data, dict):
+                return response_type(**data)
+            elif isinstance(data, list):
+                return [response_type(**item) if isinstance(item, dict) else item for item in data]
+        
+        return data
+    
+    def _get_request(self, api: str, request_data: Any = None, 
+                     response_type: Optional[Type[T]] = None,
+                     headers: Optional[Dict[str, Any]] = None) -> Optional[T]:
+        """发送 GET 请求"""
+        return self._make_request('GET', api, request_data, response_type, headers)
+    
+    def _post_request(self, api: str, request_data: Any = None, 
+                      response_type: Optional[Type[T]] = None) -> Optional[T]:
+        """发送 POST 请求"""
+        return self._make_request('POST', api, request_data, response_type)
+    
+    # ------------------------------------------------------------------------------------------
+    # 用户相关接口
+    # ------------------------------------------------------------------------------------------
+    
+    def get_user_info(self, no_cache: bool = False) -> UserInfo:
+        """获取用户信息"""
+        cache_key = f"user_info_{self.token}"
+        
+        # 检查缓存
+        if not no_cache and cache_key in self._cache:
+            cache_data = self._cache[cache_key]
+            if time.time() < cache_data['expires_at']:
+                return cache_data['data']
+        
+        # 获取用户信息
+        user_info = self._get_request('/api/users/info', response_type=UserInfo)
+        
+        # 更新缓存
+        self._cache[cache_key] = {
+            'data': user_info,
+            'expires_at': time.time() + self._cache_time
+        }
+        
+        return user_info
+    
+    def check_user_identity(self, identity: str) -> UserInfo:
+        """检查用户是否具有指定身份"""
+        user = self.get_user_info()
+        
+        if identity not in user.identity:
+            raise DooTaskPermissionException("权限不足")
+        
+        return user
+    
+    def get_user_departments(self) -> List[Department]:
+        """获取用户部门信息"""
+        return self._get_request('/api/users/info/departments', response_type=List[Department])
+    
+    def get_users_basic(self, userids: List[int]) -> List[UserBasic]:
+        """获取指定用户基础信息（支持多个用户）"""
+        params = {'userid': userids}
+        return self._get_request('/api/users/basic', params, response_type=List[UserBasic])
+    
+    def get_user_basic(self, userid: int) -> UserBasic:
+        """获取指定用户基础信息（单个用户）"""
+        users = self.get_users_basic([userid])
+        if not users:
+            raise DooTaskException("用户不存在")
+        return users[0]
+    
+    # ------------------------------------------------------------------------------------------
+    # 消息相关接口
+    # ------------------------------------------------------------------------------------------
+    
+    def send_message(self, message: SendMessageRequest) -> None:
+        """发送消息"""
+        if not message.text_type:
+            message.text_type = "md"
+        
+        self._post_request('/api/dialog/msg/sendtext', message)
+    
+    def send_message_to_user(self, message: SendMessageToUserRequest) -> None:
+        """发送消息到用户"""
+        # 获取用户对话ID
+        query_params = {'userid': message.userid}
+        response = self._get_request('/api/dialog/open/user', query_params, 
+                                   response_type=DialogOpenUserResponse)
+        
+        # 发送消息
+        self.send_message(SendMessageRequest(
+            dialog_id=response.dialog_user.dialog_id,
+            text=message.text,
+            text_type=message.text_type,
+            silence=message.silence
+        ))
+    
+    def send_bot_message(self, message: SendBotMessageRequest) -> None:
+        """发送机器人消息"""
+        if not message.bot_type:
+            message.bot_type = "system-msg"
+        
+        self._post_request('/api/dialog/msg/sendbot', message)
+    
+    def send_anonymous_message(self, message: SendAnonymousMessageRequest) -> None:
+        """发送匿名消息"""
+        self._post_request('/api/dialog/msg/sendanon', message)
+    
+    # ------------------------------------------------------------------------------------------
+    # 对话相关接口
+    # ------------------------------------------------------------------------------------------
+    
+    def get_dialog_list(self, params: Optional[TimeRangeRequest] = None) -> ResponsePaginate[DialogInfo]:
+        """获取对话列表"""
+        if params is None:
+            params = TimeRangeRequest()
+        return self._get_request('/api/dialog/lists', params, response_type=ResponsePaginate[DialogInfo])
+    
+    def search_dialog(self, params: SearchDialogRequest) -> List[DialogInfo]:
+        """搜索会话"""
+        return self._get_request('/api/dialog/search', params, response_type=List[DialogInfo])
+    
+    def get_dialog_one(self, params: GetDialogRequest) -> DialogInfo:
+        """获取单个会话信息"""
+        return self._get_request('/api/dialog/one', params, response_type=DialogInfo)
+    
+    def get_dialog_user(self, params: GetDialogUserRequest) -> List[DialogMember]:
+        """获取会话成员"""
+        return self._get_request('/api/dialog/user', params, response_type=List[DialogMember])
+    
+    # ------------------------------------------------------------------------------------------
+    # 群组相关接口
+    # ------------------------------------------------------------------------------------------
+    
+    def create_group(self, params: CreateGroupRequest) -> DialogInfo:
+        """新增群组"""
+        return self._get_request('/api/dialog/group/add', params, response_type=DialogInfo)
+    
+    def edit_group(self, params: EditGroupRequest) -> None:
+        """修改群组"""
+        self._get_request('/api/dialog/group/edit', params)
+    
+    def add_group_user(self, params: AddGroupUserRequest) -> None:
+        """添加群成员"""
+        self._get_request('/api/dialog/group/adduser', params)
+    
+    def remove_group_user(self, params: RemoveGroupUserRequest) -> None:
+        """移除群成员"""
+        self._get_request('/api/dialog/group/deluser', params)
+    
+    def exit_group(self, dialog_id: int) -> None:
+        """退出群组"""
+        self.remove_group_user(RemoveGroupUserRequest(dialog_id=dialog_id))
+    
+    def transfer_group(self, params: TransferGroupRequest) -> None:
+        """转让群组"""
+        self._get_request('/api/dialog/group/transfer', params)
+    
+    def disband_group(self, params: DisbandGroupRequest) -> None:
+        """解散群组"""
+        self._get_request('/api/dialog/group/disband', params)
+    
+    # ------------------------------------------------------------------------------------------
+    # 项目管理相关接口
+    # ------------------------------------------------------------------------------------------
+    
+    def get_project_list(self, params: Optional[GetProjectListRequest] = None) -> ResponsePaginate[Project]:
+        """获取项目列表"""
+        if params is None:
+            params = GetProjectListRequest()
+        return self._get_request('/api/project/lists', params, response_type=ResponsePaginate[Project])
+    
+    def get_project(self, params: GetProjectRequest) -> Project:
+        """获取项目信息"""
+        return self._get_request('/api/project/one', params, response_type=Project)
+    
+    def create_project(self, params: CreateProjectRequest) -> Project:
+        """创建项目"""
+        return self._get_request('/api/project/add', params, response_type=Project)
+    
+    def update_project(self, params: UpdateProjectRequest) -> Project:
+        """更新项目"""
+        return self._get_request('/api/project/update', params, response_type=Project)
+    
+    def exit_project(self, project_id: int) -> None:
+        """退出项目"""
+        params = ProjectActionRequest(project_id=project_id)
+        self._get_request('/api/project/exit', params)
+    
+    def delete_project(self, project_id: int) -> None:
+        """删除项目"""
+        params = ProjectActionRequest(project_id=project_id)
+        self._get_request('/api/project/remove', params)
+    
+    # ------------------------------------------------------------------------------------------
+    # 任务列表相关接口
+    # ------------------------------------------------------------------------------------------
+    
+    def get_column_list(self, params: GetColumnListRequest) -> ResponsePaginate[ProjectColumn]:
+        """获取任务列表"""
+        return self._get_request('/api/project/column/lists', params, 
+                               response_type=ResponsePaginate[ProjectColumn])
+    
+    def create_column(self, params: CreateColumnRequest) -> ProjectColumn:
+        """创建任务列表"""
+        return self._get_request('/api/project/column/add', params, response_type=ProjectColumn)
+    
+    def update_column(self, params: UpdateColumnRequest) -> ProjectColumn:
+        """更新任务列表"""
+        return self._get_request('/api/project/column/update', params, response_type=ProjectColumn)
+    
+    def delete_column(self, column_id: int) -> None:
+        """删除任务列表"""
+        params = ColumnActionRequest(column_id=column_id)
+        self._get_request('/api/project/column/remove', params)
+    
+    # ------------------------------------------------------------------------------------------
+    # 任务相关接口
+    # ------------------------------------------------------------------------------------------
+    
+    def get_task_list(self, params: Optional[GetTaskListRequest] = None) -> ResponsePaginate[ProjectTask]:
+        """获取任务列表"""
+        if params is None:
+            params = GetTaskListRequest()
+        return self._get_request('/api/project/task/lists', params, 
+                               response_type=ResponsePaginate[ProjectTask])
+    
+    def get_task(self, params: GetTaskRequest) -> ProjectTask:
+        """获取任务信息"""
+        return self._get_request('/api/project/task/one', params, response_type=ProjectTask)
+    
+    def get_task_content(self, params: GetTaskContentRequest) -> TaskContent:
+        """获取任务内容"""
+        return self._get_request('/api/project/task/content', params, response_type=TaskContent)
+    
+    def get_task_files(self, params: GetTaskFilesRequest) -> List[TaskFile]:
+        """获取任务文件列表"""
+        return self._get_request('/api/project/task/files', params, response_type=List[TaskFile])
+    
+    def create_task(self, params: CreateTaskRequest) -> ProjectTask:
+        """创建任务"""
+        return self._post_request('/api/project/task/add', params, response_type=ProjectTask)
+    
+    def create_sub_task(self, params: CreateSubTaskRequest) -> ProjectTask:
+        """创建子任务"""
+        return self._get_request('/api/project/task/addsub', params, response_type=ProjectTask)
+    
+    def update_task(self, params: UpdateTaskRequest) -> ProjectTask:
+        """更新任务"""
+        return self._post_request('/api/project/task/update', params, response_type=ProjectTask)
+    
+    def create_task_dialog(self, params: CreateTaskDialogRequest) -> CreateTaskDialogResponse:
+        """创建任务对话"""
+        return self._get_request('/api/project/task/dialog', params, 
+                               response_type=CreateTaskDialogResponse)
+    
+    def archive_task(self, task_id: int, archive_type: str = "add") -> None:
+        """归档任务"""
+        params = TaskActionRequest(task_id=task_id, type=archive_type)
+        self._get_request('/api/project/task/archived', params)
+    
+    def delete_task(self, task_id: int, delete_type: str = "delete") -> None:
+        """删除任务"""
+        params = TaskActionRequest(task_id=task_id, type=delete_type)
+        self._get_request('/api/project/task/remove', params)
+    
+    # ------------------------------------------------------------------------------------------
+    # 系统设置相关方法
+    # ------------------------------------------------------------------------------------------
+    
+    def get_system_settings(self) -> SystemSettings:
+        """获取系统设置"""
+        return self._get_request('/api/system/setting', response_type=SystemSettings)
+    
+    def get_version(self) -> VersionInfo:
+        """获取版本信息"""
+        headers = {'version': 'true'}
+        return self._get_request('/api/system/version', headers=headers, response_type=VersionInfo) 

dootask_tools-1.0.0.dist-info/METADATA

@@ -0,0 +1,289 @@
+Metadata-Version: 2.4
+Name: dootask-tools
+Version: 1.0.0
+Summary: DooTask Tools 客户端库
+Home-page: https://github.com/dootask/dootask-tools
+Author: DooTask Team
+Author-email: support@dootask.com
+Project-URL: Bug Reports, https://github.com/dootask/dootask-tools/issues
+Project-URL: Source, https://github.com/dootask/dootask-tools
+Project-URL: Documentation, https://github.com/dootask/dootask-tools#readme
+Keywords: dootask api client chat project management collaboration
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Office/Business :: Groupware
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28.0
+Requires-Dist: dataclasses>=0.8; python_version < "3.7"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# DooTask Tools
+
+一个用于与 DooTask 系统交互的 Python 客户端库，提供了完整的 API 封装和类型支持。
+
+## 安装
+
+```bash
+pip install dootask-tools
+```
+
+## 快速开始
+
+### 初始化客户端
+
+```python
+from dootask import DooTaskClient
+
+# 创建客户端
+client = DooTaskClient(
+    token="your_token_here",
+    server="https://your-dootask-server.com"
+)
+
+# 获取用户信息
+user = client.get_user_info()
+print(f"用户: {user.nickname}")
+```
+
+### 发送消息示例
+
+```python
+from dootask import SendMessageRequest, SendMessageToUserRequest
+
+# 发送消息到指定对话
+client.send_message(SendMessageRequest(
+    dialog_id=123,
+    text="Hello, World!",
+    text_type="md"
+))
+
+# 发送消息到用户
+client.send_message_to_user(SendMessageToUserRequest(
+    userid=456,
+    text="私信内容",
+    text_type="md"
+))
+```
+
+### 项目管理示例
+
+```python
+from dootask import GetProjectListRequest, CreateProjectRequest, CreateTaskRequest
+
+# 获取项目列表
+projects = client.get_project_list(GetProjectListRequest(
+    page=1,
+    pagesize=20
+))
+
+# 创建项目
+project = client.create_project(CreateProjectRequest(
+    name="新项目",
+    desc="项目描述"
+))
+
+# 创建任务
+task = client.create_task(CreateTaskRequest(
+    project_id=project.id,
+    name="新任务",
+    content="任务内容"
+))
+```
+
+## API 方法列表
+
+### 客户端配置
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `DooTaskClient` | 创建客户端实例 | `token, server, timeout` | `DooTaskClient` |
+
+### 用户相关接口
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `get_user_info` | 获取用户信息 | `no_cache=False` | `UserInfo` |
+| `check_user_identity` | 检查用户身份 | `identity` | `UserInfo` |
+| `get_user_departments` | 获取用户部门信息 | - | `List[Department]` |
+| `get_users_basic` | 获取多个用户基础信息 | `userids: List[int]` | `List[UserBasic]` |
+| `get_user_basic` | 获取单个用户基础信息 | `userid: int` | `UserBasic` |
+
+### 消息相关接口
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `send_message` | 发送消息 | `SendMessageRequest` | `None` |
+| `send_message_to_user` | 发送消息到用户 | `SendMessageToUserRequest` | `None` |
+| `send_bot_message` | 发送机器人消息 | `SendBotMessageRequest` | `None` |
+| `send_anonymous_message` | 发送匿名消息 | `SendAnonymousMessageRequest` | `None` |
+
+### 对话相关接口
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `get_dialog_list` | 获取对话列表 | `TimeRangeRequest` | `ResponsePaginate[DialogInfo]` |
+| `search_dialog` | 搜索会话 | `SearchDialogRequest` | `List[DialogInfo]` |
+| `get_dialog_one` | 获取单个会话信息 | `GetDialogRequest` | `DialogInfo` |
+| `get_dialog_user` | 获取会话成员 | `GetDialogUserRequest` | `List[DialogMember]` |
+
+### 群组相关接口
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `create_group` | 创建群组 | `CreateGroupRequest` | `DialogInfo` |
+| `edit_group` | 修改群组 | `EditGroupRequest` | `None` |
+| `add_group_user` | 添加群成员 | `AddGroupUserRequest` | `None` |
+| `remove_group_user` | 移除群成员 | `RemoveGroupUserRequest` | `None` |
+| `exit_group` | 退出群组 | `dialog_id: int` | `None` |
+| `transfer_group` | 转让群组 | `TransferGroupRequest` | `None` |
+| `disband_group` | 解散群组 | `DisbandGroupRequest` | `None` |
+
+### 项目管理相关接口
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `get_project_list` | 获取项目列表 | `GetProjectListRequest` | `ResponsePaginate[Project]` |
+| `get_project` | 获取项目信息 | `GetProjectRequest` | `Project` |
+| `create_project` | 创建项目 | `CreateProjectRequest` | `Project` |
+| `update_project` | 更新项目 | `UpdateProjectRequest` | `Project` |
+| `exit_project` | 退出项目 | `project_id: int` | `None` |
+| `delete_project` | 删除项目 | `project_id: int` | `None` |
+
+### 任务列表相关接口
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `get_column_list` | 获取任务列表 | `GetColumnListRequest` | `ResponsePaginate[ProjectColumn]` |
+| `create_column` | 创建任务列表 | `CreateColumnRequest` | `ProjectColumn` |
+| `update_column` | 更新任务列表 | `UpdateColumnRequest` | `ProjectColumn` |
+| `delete_column` | 删除任务列表 | `column_id: int` | `None` |
+
+### 任务相关接口
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `get_task_list` | 获取任务列表 | `GetTaskListRequest` | `ResponsePaginate[ProjectTask]` |
+| `get_task` | 获取任务信息 | `GetTaskRequest` | `ProjectTask` |
+| `get_task_content` | 获取任务内容 | `GetTaskContentRequest` | `TaskContent` |
+| `get_task_files` | 获取任务文件列表 | `GetTaskFilesRequest` | `List[TaskFile]` |
+| `create_task` | 创建任务 | `CreateTaskRequest` | `ProjectTask` |
+| `create_sub_task` | 创建子任务 | `CreateSubTaskRequest` | `ProjectTask` |
+| `update_task` | 更新任务 | `UpdateTaskRequest` | `ProjectTask` |
+| `create_task_dialog` | 创建任务对话 | `CreateTaskDialogRequest` | `CreateTaskDialogResponse` |
+| `archive_task` | 归档任务 | `task_id: int, archive_type: str` | `None` |
+| `delete_task` | 删除任务 | `task_id: int, delete_type: str` | `None` |
+
+### 系统设置相关接口
+
+| 方法 | 描述 | 参数 | 返回值 |
+|------|------|------|--------|
+| `get_system_settings` | 获取系统设置 | - | `SystemSettings` |
+| `get_version` | 获取版本信息 | - | `VersionInfo` |
+
+## 主要数据类型
+
+- `UserInfo` - 用户信息
+- `UserBasic` - 用户基础信息
+- `Department` - 部门信息
+- `DialogInfo` - 对话信息
+- `DialogMember` - 对话成员
+- `Project` - 项目信息
+- `ProjectColumn` - 项目列表
+- `ProjectTask` - 项目任务
+- `TaskFile` - 任务文件
+- `TaskContent` - 任务内容
+- `SystemSettings` - 系统设置
+- `VersionInfo` - 版本信息
+
+## 详细示例
+
+```python
+from dootask import (
+    DooTaskClient,
+    CreateProjectRequest,
+    CreateTaskRequest,
+    DooTaskException
+)
+
+client = DooTaskClient(
+    token="your_token",
+    server="https://your-server.com"
+)
+
+try:
+    # 创建项目
+    project = client.create_project(CreateProjectRequest(
+        name="我的项目",
+        desc="项目描述"
+    ))
+    
+    # 创建任务
+    task = client.create_task(CreateTaskRequest(
+        project_id=project.id,
+        name="任务名称",
+        content="任务内容",
+        owner=[user.userid]
+    ))
+    
+    print(f"项目创建成功: {project.name}")
+    print(f"任务创建成功: {task.name}")
+    
+except DooTaskException as e:
+    print(f"错误: {e}")
+```
+
+## 异常处理
+
+所有方法都可能抛出异常，包含详细的错误信息：
+
+```python
+from dootask import (
+    DooTaskException,
+    DooTaskAPIException,
+    DooTaskHTTPException,
+    DooTaskAuthException,
+    DooTaskPermissionException
+)
+
+try:
+    user = client.get_user_info()
+except DooTaskAuthException:
+    print("认证失败，请检查 token")
+except DooTaskPermissionException:
+    print("权限不足")
+except DooTaskAPIException as e:
+    print(f"API 错误: {e}")
+except DooTaskHTTPException as e:
+    print(f"网络错误: {e}")
+except DooTaskException as e:
+    print(f"其他错误: {e}")
+```
+
+## 许可证
+
+MIT License 

dootask_tools-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+client.py,sha256=5gN0cJDuy1MN42iL4OYfyAyWKVN6M_DUreFVgeliDYY,18393
+exceptions.py,sha256=xsyQ_x13Tz-NNV9g3vHRbR4PHO_Fxgb-a7Ci522e4uA,703
+models.py,sha256=V37I0Qt0RKugydiax7a0zmmGGF1nMpdgwlvkdvHK84M,11057
+dootask_tools-1.0.0.dist-info/licenses/LICENSE,sha256=XZTR4JqVYnbWD7E7Z8ID68qgYx_reZd9dpU5MameQOM,1069
+dootask_tools-1.0.0.dist-info/METADATA,sha256=KvUAuLqE7FPHqjCeYage97am-ABRKLVyY9rcLpdZLLo,9137
+dootask_tools-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dootask_tools-1.0.0.dist-info/top_level.txt,sha256=6Tc1kkb0pPCjirIzy28Nxe70crS6gyxjtP1pvmjaQYc,25
+dootask_tools-1.0.0.dist-info/RECORD,,

dootask_tools-1.0.0.dist-info/WHEEL

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

dootask_tools-1.0.0.dist-info/licenses/LICENSE

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

dootask_tools-1.0.0.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+client
+exceptions
+models

exceptions.py

@@ -0,0 +1,27 @@
+"""
+DooTask Tools 异常定义
+"""
+
+class DooTaskException(Exception):
+    """DooTask 基础异常类"""
+    pass
+
+class DooTaskAPIException(DooTaskException):
+    """DooTask API 异常"""
+    def __init__(self, message: str, ret_code: int = 0):
+        super().__init__(message)
+        self.ret_code = ret_code
+
+class DooTaskHTTPException(DooTaskException):
+    """DooTask HTTP 异常"""
+    def __init__(self, message: str, status_code: int = 0):
+        super().__init__(message)
+        self.status_code = status_code
+
+class DooTaskAuthException(DooTaskException):
+    """DooTask 认证异常"""
+    pass
+
+class DooTaskPermissionException(DooTaskException):
+    """DooTask 权限异常"""
+    pass 

models.py

@@ -0,0 +1,487 @@
+"""
+DooTask Tools 数据类型定义
+"""
+
+from dataclasses import dataclass, field
+from typing import Optional, List, Dict, Any, Union, Generic, TypeVar
+from datetime import datetime
+
+T = TypeVar('T')
+
+# ------------------------------------------------------------------------------------------
+# 基础响应结构
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class Response(Generic[T]):
+    """基础响应结构"""
+    ret: int
+    msg: str
+    data: Optional[T] = None
+
+@dataclass
+class ResponsePaginate(Generic[T]):
+    """分页数据"""
+    current_page: int
+    data: List[T]
+    next_page_url: Optional[str] = None
+    path: str = ""
+    per_page: Union[int, str] = 0
+    prev_page_url: Optional[str] = None
+    to: Union[int, str] = 0
+    total: int = 0
+
+# ------------------------------------------------------------------------------------------
+# 用户相关结构
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class UserInfo:
+    """用户信息"""
+    userid: int
+    identity: List[str] = field(default_factory=list)
+    email: str = ""
+    nickname: str = ""
+    profession: str = ""
+    userimg: str = ""
+    bot: int = 0
+    department: List[int] = field(default_factory=list)
+    department_name: str = ""
+
+@dataclass
+class UserBasic:
+    """用户基础信息"""
+    userid: int
+    email: str = ""
+    nickname: str = ""
+    profession: str = ""
+    userimg: str = ""
+    bot: int = 0
+    online: bool = False
+    department: List[int] = field(default_factory=list)
+    department_name: str = ""
+
+@dataclass
+class Department:
+    """部门信息"""
+    id: int
+    name: str
+    parent_id: int = 0
+    owner_userid: int = 0
+
+# ------------------------------------------------------------------------------------------
+# 对话相关结构
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class DialogUserResponse:
+    """对话用户信息"""
+    dialog_id: int
+    userid: int
+    bot: int = 0
+
+@dataclass
+class DialogOpenUserResponse:
+    """打开用户对话响应数据"""
+    dialog_user: DialogUserResponse
+
+@dataclass
+class DialogInfo:
+    """对话信息"""
+    id: int
+    type: str = ""
+    group_type: str = ""
+    name: str = ""
+    avatar: str = ""
+    owner_id: int = 0
+    created_at: str = ""
+    updated_at: str = ""
+    last_at: str = ""
+    mark_unread: int = 0
+    silence: int = 0
+    hide: int = 0
+    color: str = ""
+    unread: int = 0
+    unread_one: int = 0
+    mention: int = 0
+    mention_ids: List[int] = field(default_factory=list)
+    people: int = 0
+    people_user: int = 0
+    people_bot: int = 0
+    todo_num: int = 0
+    last_msg: Any = None
+    pinyin: str = ""
+    bot: int = 0
+    top_at: str = ""
+
+@dataclass
+class DialogMember:
+    """会话成员信息"""
+    id: int
+    dialog_id: int
+    userid: int
+    nickname: str = ""
+    email: str = ""
+    userimg: str = ""
+    bot: int = 0
+    online: bool = False
+
+# ------------------------------------------------------------------------------------------
+# 消息相关结构
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class SendMessageRequest:
+    """发送消息请求"""
+    dialog_id: int
+    text: str
+    text_type: str = "md"
+    silence: bool = False
+
+@dataclass
+class SendMessageToUserRequest:
+    """发送消息到用户请求"""
+    userid: int
+    text: str
+    text_type: str = "md"
+    silence: bool = False
+
+@dataclass
+class SendBotMessageRequest:
+    """发送机器人消息请求"""
+    userid: int
+    text: str
+    bot_type: str = "system-msg"
+    bot_name: str = ""
+    silence: bool = False
+
+@dataclass
+class SendAnonymousMessageRequest:
+    """发送匿名消息请求"""
+    userid: int
+    text: str
+
+# ------------------------------------------------------------------------------------------
+# 群组相关结构
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class CreateGroupRequest:
+    """创建群组请求"""
+    userids: List[int]
+    avatar: str = ""
+    chat_name: str = ""
+
+@dataclass
+class EditGroupRequest:
+    """修改群组请求"""
+    dialog_id: int
+    avatar: str = ""
+    chat_name: str = ""
+    admin: int = 0
+
+@dataclass
+class AddGroupUserRequest:
+    """添加群成员请求"""
+    dialog_id: int
+    userids: List[int]
+
+@dataclass
+class RemoveGroupUserRequest:
+    """移除群成员请求"""
+    dialog_id: int
+    userids: List[int] = field(default_factory=list)
+
+@dataclass
+class TransferGroupRequest:
+    """转让群组请求"""
+    dialog_id: int
+    userid: int
+    check_owner: str = ""
+    key: str = ""
+
+@dataclass
+class DisbandGroupRequest:
+    """解散群组请求"""
+    dialog_id: int
+
+# ------------------------------------------------------------------------------------------
+# 通用请求参数
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class TimeRangeRequest:
+    """时间范围请求参数"""
+    timerange: str = ""
+    page: int = 1
+    pagesize: int = 50
+
+@dataclass
+class SearchDialogRequest:
+    """搜索会话请求"""
+    key: str
+
+@dataclass
+class GetDialogRequest:
+    """获取单个会话请求"""
+    dialog_id: int
+
+@dataclass
+class GetDialogUserRequest:
+    """获取会话成员请求"""
+    dialog_id: int
+    getuser: int = 0
+
+# ------------------------------------------------------------------------------------------
+# 项目管理相关结构
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class Project:
+    """项目信息"""
+    id: int
+    name: str = ""
+    desc: str = ""
+    userid: int = 0
+    dialog_id: int = 0
+    archived_at: str = ""
+    created_at: str = ""
+    updated_at: str = ""
+    owner: int = 0
+    owner_userid: int = 0
+    personal: int = 0
+    # 任务统计
+    task_num: int = 0
+    task_complete: int = 0
+    task_percent: int = 0
+    task_my_num: int = 0
+    task_my_complete: int = 0
+    task_my_percent: int = 0
+
+@dataclass
+class ProjectColumn:
+    """项目列表"""
+    id: int
+    project_id: int
+    name: str = ""
+    color: str = ""
+    sort: int = 0
+    created_at: str = ""
+    updated_at: str = ""
+
+@dataclass
+class ProjectTask:
+    """项目任务"""
+    id: int
+    project_id: int = 0
+    column_id: int = 0
+    parent_id: int = 0
+    name: str = ""
+    desc: str = ""
+    start_at: str = ""
+    end_at: str = ""
+    complete_at: str = ""
+    archived_at: str = ""
+    created_at: str = ""
+    updated_at: str = ""
+    userid: int = 0
+    dialog_id: int = 0
+    flow_item_id: int = 0
+    flow_item_name: str = ""
+    visibility: int = 0
+    color: str = ""
+    # 统计信息
+    file_num: int = 0
+    msg_num: int = 0
+    sub_num: int = 0
+    sub_complete: int = 0
+    percent: int = 0
+    # 关联数据
+    project_name: str = ""
+    column_name: str = ""
+
+@dataclass
+class TaskFile:
+    """任务文件"""
+    id: int
+    task_id: int
+    name: str = ""
+    ext: str = ""
+    size: int = 0
+    path: str = ""
+    thumb: str = ""
+    userid: int = 0
+    created_at: str = ""
+    updated_at: str = ""
+
+@dataclass
+class TaskContent:
+    """任务内容"""
+    content: str = ""
+    type: str = ""
+
+# ------------------------------------------------------------------------------------------
+# 项目管理请求参数
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class GetProjectListRequest:
+    """获取项目列表请求"""
+    type: str = "all"
+    archived: str = "no"
+    getcolumn: str = "no"
+    getuserid: str = "no"
+    getstatistics: str = "no"
+    timerange: str = ""
+    page: int = 1
+    pagesize: int = 50
+
+@dataclass
+class GetProjectRequest:
+    """获取项目信息请求"""
+    project_id: int
+
+@dataclass
+class CreateProjectRequest:
+    """创建项目请求"""
+    name: str
+    desc: str = ""
+    columns: str = ""
+    flow: str = ""
+    personal: int = 0
+
+@dataclass
+class UpdateProjectRequest:
+    """更新项目请求"""
+    project_id: int
+    name: str
+    desc: str = ""
+    archive_method: str = ""
+    archive_days: int = 0
+
+@dataclass
+class ProjectActionRequest:
+    """项目操作请求"""
+    project_id: int
+    type: str = ""
+
+@dataclass
+class GetColumnListRequest:
+    """获取列表请求"""
+    project_id: int
+    page: int = 1
+    pagesize: int = 100
+
+@dataclass
+class CreateColumnRequest:
+    """创建列表请求"""
+    project_id: int
+    name: str
+
+@dataclass
+class UpdateColumnRequest:
+    """更新列表请求"""
+    column_id: int
+    name: str = ""
+    color: str = ""
+
+@dataclass
+class ColumnActionRequest:
+    """列表操作请求"""
+    column_id: int
+
+@dataclass
+class GetTaskListRequest:
+    """获取任务列表请求"""
+    project_id: int = 0
+    parent_id: int = 0
+    archived: str = "no"
+    deleted: str = "no"
+    timerange: str = ""
+    page: int = 1
+    pagesize: int = 100
+
+@dataclass
+class GetTaskRequest:
+    """获取任务信息请求"""
+    task_id: int
+    archived: str = "no"
+
+@dataclass
+class GetTaskContentRequest:
+    """获取任务内容请求"""
+    task_id: int
+    history_id: int = 0
+
+@dataclass
+class GetTaskFilesRequest:
+    """获取任务文件请求"""
+    task_id: int
+
+@dataclass
+class CreateTaskRequest:
+    """创建任务请求"""
+    project_id: int
+    name: str
+    column_id: Union[int, str] = 0
+    content: str = ""
+    times: List[str] = field(default_factory=list)
+    owner: List[int] = field(default_factory=list)
+    top: int = 0
+
+@dataclass
+class CreateSubTaskRequest:
+    """创建子任务请求"""
+    task_id: int
+    name: str
+
+@dataclass
+class UpdateTaskRequest:
+    """更新任务请求"""
+    task_id: int
+    name: str = ""
+    content: str = ""
+    times: List[str] = field(default_factory=list)
+    owner: List[int] = field(default_factory=list)
+    assist: List[int] = field(default_factory=list)
+    color: str = ""
+    visibility: int = 0
+    complete_at: Any = None
+
+@dataclass
+class TaskActionRequest:
+    """任务操作请求"""
+    task_id: int
+    type: str = ""
+
+@dataclass
+class CreateTaskDialogRequest:
+    """创建任务对话请求"""
+    task_id: int
+
+@dataclass
+class CreateTaskDialogResponse:
+    """创建任务对话响应"""
+    id: int
+    dialog_id: int
+    dialog_data: Any = None
+
+# ------------------------------------------------------------------------------------------
+# 系统设置相关
+# ------------------------------------------------------------------------------------------
+
+@dataclass
+class SystemSettings:
+    """系统设置"""
+    reg: Optional[str] = None
+    task_default_time: Optional[List[str]] = None
+    system_alias: Optional[str] = None
+    system_welcome: str = ""
+    server_timezone: Optional[str] = None
+    server_version: Optional[str] = None
+
+@dataclass
+class VersionInfo:
+    """版本信息"""
+    device_count: int = 0
+    version: str = ""