pydoro 🍅

Terminal Pomodoro Timer

Installation 🎉

Install via pip:

$ pip install pydoro
$ pydoro

Install via snap (Linux):

$ sudo snap install pydoro
$ pydoro

• NOTE: Pop!_OS users will need to run pydoro without sound, using this command option: pydoro --no-sound
• Snap package is maintained by James Tigert ( kz6fittycent )

Done.

You can also use pip install "pydoro[audio]" to get audio dependencies for OSX(pyobjc-core) and Linux(PyGObject).

Also for Linux pygame will be used if it's installed. (Try this if you cannot get PyGObject to work)

For some systems you may have to use pip3 instead. Only Python 3.6+ is supported.

On windows you may try the packaged .exe file. See the releases page.

If you have pipx:

$ pipx install pydoro

You can also inject dependencies to pipx virtual environment using

$ pipx inject pydoro pygame

Usage 📖

• Run pydoro to launch. More info in wiki.

Options: Use --no-sound to mute alarms, --no-clock to hide the clock or --focus for both clock hiding and sound muting

Credits 🙇‍♂️

• Pomodoro - Invented by Francesco Cirillo
• playsound.py - For playing audio file, Copyright (c) 2016 Taylor Marks
• prompt-toolkit - Awesome TUI library 😎
• b15.wav - Dana robinson designs, CC0 from freesound

Contributors 🙏

• Gabriel Cruz - gmelodie
• Zach Nelson - requiem
• Kajpio - kajpio
• Manuel Gutierrez - xr09
• kiba - islander
• Beatriz Uezu - beatrizuezu
• Zlatan - zlatsic
• Karolis Mažukna - nikamura
• AKeerio - akeerio
• Rohn Chatterjee - liupold
• James Tigert - kz6fittycent
• Kana - kana

Why ? 🤔

• I wanted to follow Pomodoro Technique.
• I don't like to use mobile apps or web apps.
• No user info is stored, tracked or shared.
• I spend lot of time on my Terminal.
• Written in Python 🐍.

Copyright ⚖

This software is Copyright (c) 2021 - 2024 Bhathiya Perera.

See the LICENSE file for more information.