pompom

pompom is a command line interface (CLI) application that utilizes the pomodoro technique to fight procrastination and help track time.

Pomodoro technique

The pomodoro technique is a simple technique that helps individuals fight procrastination by using a simple timer. The standard pomodoro timer is to work for 25 minutes and take a 5 minute break. You can read more about the technique here.

Installation

git clone https://github.com/connortoliver/pompom
cd pompom-cli
pip install -r requirements.txt
python setup.py install

You may have to use python3.7 or other version number if you have multiple versions of Python installed.

pompom Usage

pompom [ontime] [breaktime] [activity] [OPTIONS]

• ontime is the amount of time you want to work in minutes. Default is 25 minutes.
• breaktime is the amount of break time in minutes per cycle. Default is 5 minutes.
• activity is the activity you are working on (studying, reading, programming...). Default is 'Default'.

pompom 45 15 will create a timer with 45 minutes on, 15 minutes off for activity 'Default'.

pompom 25 5 Programming will create a timer with 25 minutes on, 5 minutes off for activity 'Programming'.

Options

• --alarm [on/off] turns the alarm sound on or off. Default is on.
• --auto [on/off] sets whether the timer cycles automatically or not. Default is on.

How pompom was made

pompom was built using Click, a Python package for creating command line interfaces quickly and easily.pip