Taskmate

🚀 Task Manager Usage Guide

This guide offers a detailed overview of the TaskMateAI project, including its structure, testing procedures, and future development plans.

🚀 Quick Start

The project structure is designed to ensure clear organization and efficient development. Here is a high - level overview of the key components:

Directory Structure

1. src/TaskMateAI: Contains the main program code and package initialization files.
2. output/: Used to store automatically generated task data files.
3. tests/: Includes test code, divided into unit tests and integration tests.
4. requirements.txt: Lists the third - party library dependencies required for the project.
5. README.md: A brief project description and usage guide.

Task Data Storage

All task data will be automatically saved to the output/tasks.json file. This file is updated every time a task operation is performed.

📦 Installation

Before running the project, you need to install the required dependencies. Navigate to the project root directory and run the following command:

pip install -r requirements.txt

💻 Usage Examples

Project Structure

TaskMateAI/
├── src/
│   └── TaskMateAI/
│       ├── __init__.py      # Package initialization file
│       └── __main__.py      # Main application code
├── output/                  # Data storage directory
│   └── tasks.json           # Task data (automatically generated)
├── tests/                   # Test code
│   ├── unit/                # Unit tests
│   │   └── __init__.py
│   ├── integration/         # Integration tests
│   └── conftest.py          # Test fixtures definition file
├── requirements.txt         # List of dependent packages
└── README.md                # This file

Test Structure

tests/
├── __init__.py           # Test package initialization file
├── conftest.py           # Test fixtures definition file
├── unit/                 # Unit tests
│   ├── __init__.py
│   ├── test_task_utils.py       # Tests for task - related utilities
│   ├── test_mcp_tools.py        # Tests for MCP tool functionality
│   └── test_agent_projects.py   # Tests for agent and project management functionality
└── integration/          # Integration tests
    └── __init__.py

Test Execution

Execute all tests

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

Execute a specific test file

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

Execute a specific test class

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

Execute a specific test function

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

📚 Documentation

Future Improvement Plans

• Implement task template functionality.
• Build a task dependency management system.
• Add a calendar feature.
• Introduce a tag classification system.
• Implement milestone management functionality.

📄 License

This project is licensed under the MIT License.

👨‍💻 Author Information

NewAITees