Skip to content

Implement review command for activity insights #7

@simonsan

Description

@simonsan

Overview

The pace CLI currently lacks a comprehensive way to review and summarize time spent on various activities. Users need an intuitive command to generate a detailed report of their activities, grouped by categories and subcategories, with total time spent on each. The proposed review command aims to fill this gap by aggregating activity data and presenting it in a structured and readable format.

Objectives

  • Implement a review command that aggregates activity data.
  • Group activities by categories and subcategories.
  • Display total time spent on each activity and category.
  • Ensure the output is formatted for easy readability.

Proposed Enhancements

  1. Data Aggregation Logic (pace_core)

    • Develop logic to parse activities_<date>.pace.toml and any associated activity logs.
    • Aggregate activities by categories and subcategories.
    • Calculate total time spent on each activity and category.
  2. Command Implementation (pace)

    • Implement the review command in the CLI interface using clap.
    • Integrate the data aggregation logic with the review command.
  3. Output Formatting (pace_core)

    • Design a format for the output with enhanced readability.
    • Implement formatting logic that aligns with the designed format.

Further Improvements

  • Provide options to filter the review by date range, e.g., --from and --to flags.
  • Allow users to export the review report to different formats, such as Markdown, PDF, json, and csv.
  • Implement caching mechanisms to improve performance for generating reviews.

Request for Comments (RFC)

Feedback is requested from contributors and users on the following:

  • Suggestions for the output format and additional formatting features.
  • Ideas for optimizing data aggregation and report generation.
  • Interest in additional filtering and export options.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-cliArea: Related to our command line interfaceA-commandsArea: Related to our commands in generalA-ui-uxArea: Related to user interfaces and user experienceC-enhancementCategory: New feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions