Skip to content

Iain05/Checkin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📔Checkin

This project is not working or anything yet (not really at least), if you are reading this and you aren't me, go away >:( come back later <3.

Okay chat here's the idea hear me out. A CLI app that you can use to track your mood each day throughout the year. Using a terminal plotting library (hopefully) it can display statistics through the year so far, all data gets saved as a csv and can be exported to a spreadsheet. It can track the following data:

Tracking data range Extra notes
Mood 0 - 5
Energy 1 - 10
Daily Activities Multi-select
Cry y/n
Productive Hours 0.0 - 24.0
Hours of Sleep 0.0 - 24.0

Hopeful Features

  • Spreadsheet exporting from the csv files
  • editing previous checkins
    • 1-12 month then 1-3[01] day
  • graph specific metrics in the terminal
  • (VERY MAYBE) customize using a config what metrics checkin tracks
    • E.g. Only track mood and energy
    • Change the display of the mood values from default (purely visual/ux)

Commands

checkin start

Starts the checkin session and its prompts.

checkin edit

Change a previous checkin.

  • -v, --view flag to view and edit missed checkins.
  • %Y-%m-%d argument to specify the date of the checkin to edit.

checkin graph

Prompts the user to select a metric to graph right in the terminal.

checkin spotify

Fetches and displays Spotify data.

  • -m flag to show past month's top played.
  • -y flag to show past year's top played.
  • -h flag to show past 6 months' top played.
  • -a flag to display artists instead of songs (defaults to getting songs).
  • --top n option to get the top n items.
  • --store flag to store top played data.

Installation and Configuration

To install this into your system, you can simply run the command

pipx install git+https://github.com/Iain05/checkin.git

Next you need to set the environment variables for spotify integration (I'll make this optional eventually), which can be done on Linux by adding the following lines to your .bashrc likely in your home directory.

export SPOTIPY_CLIENT_ID="spotify_api_client_id_here"
export SPOTIPY_CLIENT_SECRET="spotify_api_client_secret_here"

Upon first running checkin start, it should automatically create a folder .checkin inside your home directory that contains all the user data.

To-do list

  • finish adding metrics to track
  • list old entries and missed entries
    • For this I need to figure out a way to have a scrollable selector lol
  • prompt user to add missing entries
  • edit previous entries
    • Okay preferably I could have a cool like date selector thing but i havent found one yet
  • change date format of stored data and graph
  • automatically start storing spotify data near end of month

About

CLI program to track and graph how you feel and what you did on daily basis

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages