Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement review command for activity insights #7

Open
8 of 10 tasks
simonsan opened this issue Feb 13, 2024 · 0 comments
Open
8 of 10 tasks

Implement review command for activity insights #7

simonsan opened this issue Feb 13, 2024 · 0 comments
Labels
A-cli Area: Related to our command line interface A-commands Area: Related to our commands in general A-ui-ux Area: Related to user interfaces and user experience C-enhancement Category: New feature or request

Comments

@simonsan
Copy link
Contributor

simonsan commented Feb 13, 2024

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.
@simonsan simonsan added A-cli Area: Related to our command line interface A-commands Area: Related to our commands in general A-ui-ux Area: Related to user interfaces and user experience C-enhancement Category: New feature or request labels Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-cli Area: Related to our command line interface A-commands Area: Related to our commands in general A-ui-ux Area: Related to user interfaces and user experience C-enhancement Category: New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant