https://github.com/tokisuno/phat

https://github.com/tokisuno/phat

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/tokisuno/phat
• Owner: tokisuno
• License: mit
• Created: 2024-06-07T16:22:49.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-11T16:43:07.000Z (6 months ago)
• Last Synced: 2024-08-07T14:47:47.620Z (5 months ago)
• Language: Go
• Size: 25.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# [phat] -- pomodoro & habit tracker & time logger

[cobra guide](https://github.com/spf13/cobra/blob/main/site/content/user_guide.md)

* pomodoro with user-defined settings

    - defaults: 60/10 x 3 sessions

    - habit: required field (cannot be left blank)

    

* data stored in local CSV file:

    - name of habit             "string"

    - total habit time          "int"

    - habit status              "bool"

        - set minute goal for habit

        - if it reaches the minute goal, status=true

## Base File

"programming",60

programming.goal = 60

if goal met:

    add row to csv_file and add bool

programming,60,true

## Pomodoro function

```bash

0> phat -h programming

```

- starts a pomodoro in the terminal

    -> add habit name to .csv

- counts down the minutes, and seconds

- per session ending, return the time elapsed 

    -> add the time elapsed to .csv file

- run through break function (don't record time)

- until it's the final session

    -> don't run a break if it's the final session

- after the final session, display the stats of the session

    -> data from the .csv file

## Quality of life

- in the `config.yaml`, list habits that can be picked from as defaults

    - `config.yaml` is placed in `$HOME/.config/phat`