本项目是一个任务管理工具,能够帮助用户高效地管理任务,并且提供了详细的测试结构和执行方法,方便开发者进行功能验证和维护。
本项目的快速开始步骤主要涉及测试的执行,以下是不同场景下的测试执行方法:
cd /path/to/TaskMateAI
uv run python -m pytest -xvs
uv run python -m pytest -xvs tests/unit/test_task_utils.py
uv run python -m pytest -xvs tests/unit/test_mcp_tools.py::TestMCPTools
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 # 本文件
src/TaskMateAI:包含主程序代码和包初始化文件。output/:用于存储自动生成的任务数据文件。tests/:包含测试代码,分为单元测试和集成测试。requirements.txt:列出项目所需的第三方库依赖。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 许可证。