jps-effort-tracker-utils 1.1.0

A command-line task and effort tracking utility for managing daily tasks with priorities, effort estimates, and status tracking.

jps-effort-tracker-utils

A command-line task and effort tracking utility for managing daily tasks with priorities, effort estimates, and status tracking.

Table of Contents

• Overview
• Features
• Installation
• Quick Start
• Usage
  • Add Task
  • View Tasks
  • Delete Task
  • Update Task
• Task Properties
• Configuration
• Development
• Testing
• Contributing
• License

Overview

jps-effort-tracker-utils is a Python package that provides command-line tools for tracking tasks and effort. It helps you organize your daily work by managing tasks with detailed attributes including priority levels, effort estimates, due dates, status tracking, and integration with issue trackers.

Tasks are stored in YAML files organized by date, making it easy to track your work history and transfer incomplete tasks between days automatically.

Features

✅ Task Management: Add, view, delete, and update tasks via simple CLI commands

✅ Rich Task Attributes:

• Task ID (auto-generated timestamps)
• Title and description
• Priority levels (1-5)
• Due dates
• Status tracking (pending, in-progress, completed, deleted, not started)
• Effort estimates (in minutes)
• Level of effort categories (Easy, Medium, Hard, Complex)
• Issue tracker integration
• Issue types (enhancement, bugfix, documentation, etc.)

✅ Smart Features:

• Automatic transfer of incomplete tasks to the next day
• Date-based task file organization
• Beautiful Rich tables for task viewing with configurable columns
• Interactive task selection and detailed views
• Colored console output for better readability
• YAML-based storage for easy inspection and editing
• Configurable task storage directory

✅ Developer-Friendly:

• Comprehensive test suite with pytest
• Type hints throughout
• Rich console output with Typer CLI framework
• Detailed logging

Installation

For detailed installation instructions, see INSTALL.md.

Quick Install

pip install jps-effort-tracker-utils

From Source

git clone https://github.com/jai-python3/effort-tracker-utils.git
cd effort-tracker-utils
pip install -e .

Quick Start

# View all available commands
jps-effort-tracker --help

# Add a new task
jps-effort-tracker add-task

# View tasks for today
jps-effort-tracker view-tasks

# Update an existing task
jps-effort-tracker update-task

# Delete a task
jps-effort-tracker delete-task

# Show version
jps-effort-tracker version

Usage

All commands are accessed through the main jps-effort-tracker CLI tool.

Add Task

Interactively add a new task with all properties:

jps-effort-tracker add-task

With options:

jps-effort-tracker add-task --config-file /path/to/config.yaml --verbose

Options:

• --config-file, -c: Configuration file path (default: built-in config)
• --task-file, -t: Specific task file to use (default: today's file)
• --logfile, -l: Log file path
• --outdir, -o: Output directory for logs
• --verbose, -v: Enable verbose output

View Tasks

View and browse your tasks in a beautiful Rich table:

jps-effort-tracker view-tasks

This will:

1. Display all tasks in a formatted table with configurable columns
2. Allow you to select a task by number to view full details
3. Show detailed task information in a formatted table
4. Press Enter to return or quit

Table Configuration:

The columns displayed in the tasks table are configured in your config.yaml:

view_tasks:
  fields:
    - title
    - status
    - priority
    - level_of_effort
    - effort_estimate
    - due_date

You can customize which fields appear and their order by editing this configuration.

Delete Task

Remove a task from the list:

jps-effort-tracker delete-task

Select the task number you want to delete.

Update Task

Modify an existing task:

jps-effort-tracker update-task

This will:

1. Display all current tasks
2. Prompt you to select a task by number
3. Allow you to update any field (press Enter to keep current value)
4. Save the changes to the task file

You can update all task properties including title, description, priority, status, effort estimate, level of effort, issue tracker details, and due date. Current values are shown in brackets for reference.

Version

Show version information:

jps-effort-tracker version

Task Properties

Each task includes:

Property	Type	Description
task_id	string	Auto-generated timestamp ID (YYYY.MM.DD.HH.MM.SS)
title	string	Short task title
description	string	Detailed task description
priority	int	Priority level (1-5)
due_date	datetime	When the task is due
date_created	datetime	When the task was created
status	string	Current status (pending, in-progress, completed, etc.)
completed	bool	Whether the task is completed
issue_tracker_id	string	External issue tracker reference
issue_type	string	Type of work (enhancement, bugfix, etc.)
effort_estimate	int	Estimated duration in minutes
level_of_effort	string	Complexity category (Easy, Medium, Hard, Complex)

Configuration

Default configuration is stored at src/jps_effort_tracker_utils/conf/config.yaml. You can provide a custom configuration:

tasks_dir: /path/to/your/tasks

By default, tasks are stored in: ~/effort-tracker-utils/tasks/

Each day gets its own YAML file: YYYY-MM-DD.yaml

Development

Setup Development Environment

git clone https://github.com/jai-python3/effort-tracker-utils.git
cd effort-tracker-utils
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -e ".[dev]"

Code Quality Tools

The project uses:

• Typer for CLI framework
• Rich for beautiful terminal output
• Black for code formatting
• isort for import sorting
• flake8 for linting
• mypy for type checking
• pylint for additional linting
• pytest for testing

# Format code
black src tests

# Sort imports
isort src tests

# Run linters
flake8 src
mypy src

# Run tests
pytest tests/

Testing

The project has a comprehensive test suite covering:

• Constants and configuration
• Task manager and Task model
• Package metadata
• CLI functionality

# Run all tests
pytest tests/ -v

# Run with coverage
pytest tests/ --cov=src/jps_effort_tracker_utils --cov-report=term-missing

# Run specific test file
pytest tests/test_manager.py -v

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests and linters
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.