Taskmate

🚀 任務管理器使用指南

本項目是一個任務管理工具，能夠幫助用戶高效地管理任務，並且提供了詳細的測試結構和執行方法，方便開發者進行功能驗證和維護。

🚀 快速開始

本項目的快速開始步驟主要涉及測試的執行，以下是不同場景下的測試執行方法：

1. 執行所有測試：

cd /path/to/TaskMateAI
uv run python -m pytest -xvs

2. 執行特定的測試文件：

uv run python -m pytest -xvs tests/unit/test_task_utils.py

3. 執行特定的測試類：

uv run python -m pytest -xvs tests/unit/test_mcp_tools.py::TestMCPTools

4. 執行特定的測試函數：

uv run python -m pytest -xvs tests/unit/test_task_utils.py::TestTaskUtils::test_read_tasks_with_data

✨ 主要特性

• 自動保存任務數據到output/tasks.json文件，每次任務操作都會更新該文件。
• 提供了完善的測試結構，包括單元測試和集成測試，方便開發者進行功能驗證和維護。
• 有明確的未來改進計劃，如實現任務模板功能、構建任務依賴關係管理系統等。

📦 安裝指南

項目所需的第三方庫依賴列在requirements.txt文件中，你可以使用以下命令進行安裝：

pip install -r requirements.txt

💻 使用示例

基礎用法

本項目主要通過命令行執行測試來驗證功能，以下是執行所有測試的示例：

cd /path/to/TaskMateAI
uv run python -m pytest -xvs

高級用法

執行特定的測試函數，例如執行tests/unit/test_task_utils.py文件中的TestTaskUtils類下的test_read_tasks_with_data函數：

uv run python -m pytest -xvs tests/unit/test_task_utils.py::TestTaskUtils::test_read_tasks_with_data

📚 詳細文檔

項目構造

TaskMateAI/
├── src/
│   └── TaskMateAI/
│       ├── __init__.py      # 包初始化文件
│       └── __main__.py      # 主應用程序代碼
├── output/                  # 數據存儲目錄
│   └── tasks.json           # 任務數據（自動生成）
├── tests/                   # 測試代碼
│   ├── unit/                # 單元測試
│   │   └── __init__.py
│   ├── integration/         # 集成測試
│   └── conftest.py          # 測試 fixtures 定義文件
├── requirements.txt         # 依賴包列表
└── README.md                # 本文件

項目結構說明

目錄結構

1. src/TaskMateAI：包含主程序代碼和包初始化文件。
2. output/：用於存儲自動生成的任務數據文件。
3. tests/：包含測試代碼，分為單元測試和集成測試。
4. requirements.txt：列出項目所需的第三方庫依賴。
5. README.md：項目的簡要說明和使用指南。

任務數據存儲

所有任務數據將被自動保存到output/tasks.json文件中。每次對任務進行操作時，該文件都會被更新。

測試結構

測試代碼位於tests/目錄下，採用以下結構：

tests/
├── __init__.py           # 測試包初始化文件
├── conftest.py           # 測試 fixtures 定義文件
├── unit/                 # 單元測試
│   ├── __init__.py
│   ├── test_task_utils.py       # 任務相關工具的測試
│   ├── test_mcp_tools.py        # MCP 工具功能的測試
│   └── test_agent_projects.py   # 代理和項目管理功能的測試
└── integration/          # 集成測試
    └── __init__.py

🔧 技術細節

本項目的測試代碼採用pytest框架進行編寫，通過conftest.py文件定義測試 fixtures，方便在不同的測試文件和測試類中複用。測試代碼分為單元測試和集成測試，單元測試主要針對單個函數或類進行測試，集成測試則用於驗證多個組件之間的交互。

📄 許可證

本項目採用 MIT 許可證。

👨‍💻 作者信息

NewAITees