DevelopmentHF / cherry

Minimalistic macOS CLI Pomodoro Timer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cherry ๐Ÿ’

Cherry is currently macOS only minimalistic command line pomodoro timer, utilising the curses module.

It aims to have as few distractions as possible, allowing you to get on with your work.

Your work time will be broken up into sessions of 25 minutes, with a 5 minute break in between these.
On your fourth break, the break time will be extended to 30 minutes, in keeping with the traditional pomodoro technique ๐Ÿ….

In future, Cherry may have variations on the traditional pomodoro technique, such as flow modes. The command list and this README will be updated accordingly.


cherry banner

cherry program


Commands

Starting / Restarting the central timer: s


Pausing the central timer: p


Exiting Cherry: q


Note: Cherry is CAPS-sensitive, so please use lowercase characters to operate the program


Dependencies

None, except for having macOS.
macOS comes with curses installed, and while windows computers can download an external module to get access to curses, the sound alert feature would break.

Windows support may come in future updates.


Running Cherry

In order to run Cherry, do the following, its easy :)

git clone [url]

If you do not have git, manually download this repository


cd cherry/src

python3 main.py

Alternatively, you can just run the cherry.exe, which has been bundled using pyinstaller.


That's it. Enjoy ๐Ÿ’

About

Minimalistic macOS CLI Pomodoro Timer

License:MIT License


Languages

Language:Python 100.0%