COMODORO

Comodoro is a cross platform Graphical User Interface (GUI) and Command Line Interface (CLI) app that implements the pomodoro technique.

STATUS

This project is currently not maintained. It feels like I'm re-inventting the wheel :). There are already so many pomodoro apps out there. e.g. yapa.
If you want to continue building it, fork it! Tbh, I have learnt a lot building it. I just think it is better spending my time building other stuffs.
The GUI works but nothing about the CLI has been implemented. I was thinking of using arg parse for the CLI.Then use argparse.Action to send a pubsub message to the CLI controller that will then talk to the engine via zmq sockets.

INSTALLATION

At this point, comodoro doesn't have an installer, so you will have to build a stand alone executable yourself or run it from source. We will only cover running it from source for now. Installers will be created when the project is at beta stage.

DEPENDENCIES

Dependencies not related to python
To be able to play a sound when a timer is done, you'll have to install the libvlc library or vlc. If you already have vlc, you are good to go.

LINUX

To install libvlc on ubuntu, open a terminal and run this command:

sudo apt-get install libvlc-dev

WINDOWS

Open your terminal and run the command:

winget install VideoLAN.VLC.SDK

MACOS

Open your terminal and run this command:

brew install libvlc

Running From Source

1. You will need python3.10.x. We aren't using the latest version of python (python3.11) because the GUI library comodoro is using has a bug that makes installing it via pip buggy. If you don't have python, you can get one here.
2. To run it from source, start by cloning this repo:

   git clone https://arfs6/comodoro

   3. change your working folder / directory to the root of the project:

cd comodoro

4. Next, install all the required python packages using pip:

pip install -r requirements.txt

Creating Standalone Executable

1. Do all the above steps for running from source.
2. Change your directory to the src directory.

   $ cd src

3. Start the build process.

   $ python setup.py build

   The executable will be found in build/*/Comodoro.exe.

USAGE

You can use comodoro in two ways. Using the GUI and CLI.

GUI

To start comodoro and show the GUI:

1. Just click the main.pyw file from your GUI.
2. Run the main.pyw file from terminal without any argument

CLI

This is currently not supported but will be added shortly.

Contributions

All contributions are highly welcomed. Read our contributing.md on how to contribute to comodoro.

LICENSE

This software is licensed under the GNU General Public License. You can find the license in the LICENSE.md file.