Home

Welcome to the pydoro 🍅 wiki!

Usage

• Simply run pydoro and it will start with the TUI (Text User Interface).

Keyboard Shortcuts

• Focus Next: Tab | -> | l | k
• Focus Previous: Shift + Tab | <- | h | j
• Exit: q
• Start: s
• Pause: p
• Reset: r
• Reset All: a

Configuration

• If PYDORO_CONFIG_FILE is set configuration is loaded from that location.
• Default location is ~/.pydoro.ini (Windows: C:\Users\<User>\.pydoro.ini)
• Configuration with default values will be created if file doesn't exist.
• This file must be writable from pydoro.
• There are no validations yet! 💀

Config INI

[General]
# Set this to True to disable clock animation
no_clock = False
# Set this to True to disable sounds
no_sound = False
# Set this to True to enable emoji tomatoes
emoji = False

[Time]
# Tomatoes in a set usually this is a 4
tomatoes_per_set = 4
# Work time in minutes
work_minutes = 25
# Small break time in minutes
small_break_minutes = 5
# Long break time in minutes
long_break_minutes = 15
# How long does alarm goes on (if sound is enabled)
alarm_seconds = 20

[KeyBindings]
# Remove any of the lines below - to not have a binding for respective function
# Navigate to previous button
focus_previous = s-tab,left,h,j
# Navigate to next button
focus_next = tab,right,l,k
exit_clicked = q
start = s
pause = p
reset = r
reset_all = a

Key Bindings

• Custom keys allow aliases to be defined. Simply separate them from space
• Refer Keybinding documentation
• Limitation: Alt/Meta + x - not supported.
• Limitation: Key sequences are not supported.

CLI Arguments

usage: pydoro [-h] [-e] [--focus] [--no-clock] [--no-sound]

Terminal Pomodoro Timer

optional arguments:
  -h, --help   show this help message and exit
  -e, --emoji  If set, use tomato emoji instead of the ASCII art
  --focus      focus mode: hides clock and mutes sounds (equivalent to --no-
               clock and --no-sound)
  --no-clock   hides clock
  --no-sound   mutes all sounds

Developer Guide

You can find the developer guide here.