Skip to content

Home

Jump to bottom
quantuumhedgehog edited this page Nov 29, 2024 · 8 revisions

Welcome to Task Tracker CLI Wiki! 📍

A robust command-line task management application built in Python that helps you organize and track your tasks efficiently.

This is an implementation of the Task Tracker Project from roadmap.sh.

Quick Navigation 📍

📚 Additional Resources:

Overview 📚

Task Tracker CLI is a powerful yet simple command-line application that helps you manage your tasks effectively. Whether you're a developer managing project tasks or someone looking to organize personal todos, Task Tracker CLI provides an efficient way to track your work.

Documentation Structure 📑

The project documentation is organized into several key files:

  • README.md - Main project documentation and quick start guide
  • CHANGELOG.md - Tracks all project changes and version history
  • FUTURELOG.md - Outlines planned features and improvements
  • Sphinx Documentation - Comprehensive API documentation and guides

For detailed information about specific aspects of the project, please refer to the wiki sections listed in Quick Navigation above.

Quick Start 🚀

# Install the application
pip install task-tracker-cli

# Create your first task
task-cli add "Complete the project documentation"

# List all tasks
task-cli list

Support and Resources 📚

  • Check the User Guide for detailed usage instructions
  • Join our community discussions in Social Sharing
  • Report issues on our GitHub repository

License and Credits 📜

This project is licensed under the MIT License. See the LICENSE file in the main repository for details.

Features 🎉

  • Task Management

    • Create tasks with descriptions
    • List all tasks or filter by status
    • Update task descriptions
    • Mark tasks as todo/in-progress/done

  • Data Persistence

    • Automatic JSON storage
    • Timestamps for creation and updates
    • Data integrity checks

Prerequisites 📝

  • Python 3.10 or higher
  • pip (Python package installer)

Installation 📦

From Source

  1. Clone the repository:
git clone <repository-url>
cd roadmaps-python-task-tracker
  1. Install in development mode:
# Install with development dependencies
pip install -e ".[dev]"

# Or install just the application
pip install -e .

Via pip (when published)

pip install task-tracker-cli

Build from Source

# Install build dependencies
pip install build

# Build the package
python -m build

# Install the built package
pip install dist/task_cli-0.1.0-py3-none-any.whl

Usage 📚

The task-cli command provides several subcommands for task management:

Task Creation

# Add a new task
task-cli add "Complete the project documentation"

Task Listing

# List all tasks
task-cli list

# List tasks by status
task-cli list todo
task-cli list in-progress
task-cli list done

Task Updates

# Edit task description
task-cli edit <task-id> "Updated task description"

# Update task status
task-cli mark-todo <task-id>
task-cli mark-progress <task-id>
task-cli mark-done <task-id>

Development 📈

Testing

The project includes two testing implementations to demonstrate different Python testing approaches:

Using unittest

The unittest implementation follows Python's built-in testing framework approach:

# Run unittest tests
python -m unittest tests/test_task_cli_unittests.py -v

Key features:

  • Uses Python's standard library testing framework
  • Class-based test organization
  • Built-in assertion methods
  • Test discovery and execution

Using pytest

The pytest implementation offers a more modern and feature-rich testing approach:

# Run basic tests
pytest tests/test_task_cli_pytest.py -v

# Run tests with coverage report
pytest tests/test_task_cli_pytest.py -v --cov=src/task_cli

# Generate HTML coverage report
pytest tests/test_task_cli_pytest.py --cov=src/task_cli --cov-report=html

Key features:

  • Fixtures for better test setup and teardown
  • Powerful assertion introspection
  • Built-in parameterization
  • Rich plugin ecosystem
  • Coverage reporting
  • Parallel test execution (with pytest-xdist)

Project Structure

task-tracker-cli/           # Root project directory
├── src/                    # Source code directory
│   └── task_cli/          # Main package directory
│       ├── __init__.py    # Package initialization
│       ├── __main__.py    # Entry point for CLI
│       └── task_cli.py    # Core implementation
├── tests/                  # Test files directory
│   ├── test_task_cli_pytest.py  # Pytest test suite
│   └── test_task_cli_unittests.py  # Unittest test suite
├── README.md              # Project documentation
└── pyproject.toml         # Project metadata and dependencies

Data Storage 📁

Tasks are stored in a JSON file (tasks.json by default) with the following schema:

[
    {
        "id": 1,
        "description": "Task description",
        "status": "todo",
        "createdAt": "2024-01-01T10:00:00",
        "updatedAt": "2024-01-01T10:30:00"
    }
]

Acknowledgments 🙏

This project is prepared within the Python Developer path on Roadmap.sh.

Clone this wiki locally