Pymodoro

Running

Xmobar

Put the files into a new folder called .pymodoro inside your home folder. Configure your xmobar to display pymodoro with

Run CommandReader "PATH/TO/pymodoro.py" "pomodoro"

Then add it to your template.

Dzen2

Add the following configuration to your Dzen2 configuration file to retrieve the current status of your Pomodoro and paste it in your display.

^fg(\#FFFFFF)${execi 10 python PATH/TO/pymodoro.py -o}

i3

The i3 module adds a little extra to pymodoro: it's using a color gradient to display the bar, from green to red depending on how may time is left. For the gradient to work, you need the colour python library first.

pip install colour

You then need to use py3status an i3status wrapper written in python.

In your ~/.i3/config file, use py3status as your status command and give your pymodoro install directory (the directory containing pymodoro.py) as an include path:

status_command py3status -i PATH_TO_PYMODORO

Then add the module to your statusbar conf file (~/.config/i3status/config on my setup):

order += "pymodoroi3"

Install

To install Pymodoro system wide, run the setup.py script like this:

python setup.py install

You can also install Pymodoro using pip, without having to download/clone the code manually:

pip install git+https://github.com/dattanchu/pymodoro.git

Usage

A new Pomodoro -- 25 minutes followed by a break of 5 minutes -- is started by changing the timestamp of $XDG_CACHE_HOME/pomodoro_session. This can be done by the shell command:

touch ~/.cache/pomodoro_session

If you want to use counters with different times, write them into the session file. The first number specifies the length of the Pomodoro in minutes, the second one the length of the break. Both numbers are optional. Example:

echo "20 2" > ~/.cache/pomodoro_session

Sending a SIGHUP to the process will toggle the ticking sound.

Keybindings

The easiest way is to define keybindings for the commands.

Xmonad

Configure xmonad to start a new Pomodoro session by adding this to your xmonad.hs:

-- start a pomodoro
, ((modMask, xK_n), spawn "touch ~/.cache/pomodoro_session")

Or:

-- start a pomodoro
, ("M-n", spawn "touch ~/.cache/pomodoro_session")

This way, whenever you hit modMask + n, you will start a new pomodoro.

i3

Here are some shortcuts examples for i3.

# stop a pomodoro
bindsym $mod+Shift+f exec rm ~/.cache/pomodoro_session

# start/reset a pomodoro
bindsym $mod+Shift+h exec touch ~/.cache/pomodoro_session

Configure

You can set all the options via command line parameters. For a detailed description run:

pymodoro.py --help

It is no longer needed to edit the script itself.

Hooks

The hooks are configurable via the following settings in the [Hooks] section of the configuration file. The hooks should be set to the absolute path of an executable file (binary, bash script, Python script, etc) which you want to run when the associated event happens.

• pomodoro_start: runs whenever a pomodoro is started
• pomodoro_complete: runs whenever a pomodoro completes by the timer elapsing
• pomodoro_end: runs whenever a pomodoro ends, whether by elapsing or by the user terminated it manually (by deleting the session file)
• break_complete: runs whenever a break ends completes by the timer elapsing
• idle_start: runs whenever the idle state starts (which only happens when the session file is deleted)

Credits

• Thanks to Mirko Horstmann for the ticking sound.
• Session and Break sounds from Soothing Alerts by Adam Dachis