A command line tool to calculate the number of pomodoros available between two points in time.
Find a file
2023-08-04 12:50:14 +01:00
pomodoro_calculator chore: bump version for pypi 2023-08-04 12:50:14 +01:00
.gitignore Update .gitignore, ignore Python packaging files 2014-06-12 00:22:09 +01:00
.travis.yml Remove support for Python 2.6 2014-06-12 13:22:17 +01:00
CONTRIBUTORS.txt Added option to write out more comprehensive report of the plan. 2018-09-02 11:36:37 +02:00
LICENCE docs: update README and LICENCE 2023-08-04 12:49:21 +01:00
MANIFEST.in Add setuptools configuration setup.py, ready for PyPi 2014-06-12 00:40:50 +01:00
README.md docs: update README and LICENCE 2023-08-04 12:49:21 +01:00
requirements.txt Update freezegun for Python 2.7 compatibility 2015-08-28 09:22:04 +01:00
screenshot.png Update screenshot 2016-03-04 13:41:27 +00:00
setup.cfg Add setup.cfg, so we can specify this wheel as universal 2014-06-12 13:32:01 +01:00
setup.py docs: update README and LICENCE 2023-08-04 12:49:21 +01:00

Pomodoro Calculator

A command line tool to calculate the number of Pomodoros available between two points in time.

Pomodoro Calculator screenshot

Installation

You can install the Pomodoro Calculator using pip:

    $ pip install pomodoro-calculator

Usage

Use the get-pomodori command from the shell to run Pomodoro Calculator:

    $ get-pomodori --help
    Calculate the number of Pomodori available within a time period.

    Usage:
      get-pomodori [--pomodoro=<time>] [--from=<time>] [--break=<minutes>] [--long-break=<minutes>]
                   [--group=<pomodori>] [--interval] [--json] [--nocolour] [--amount] [--extensive-report] <end-time>
      get-pomodori (-h | --help | --version)

    Options:
      --version                   show program's version number and exit.
      -h, --help                  show this help message and exit.
      -i, --interval              specify that the end time is a time interval, not a time of day.
      -f, --from=<time>           calculate available Pomodori from this time [default: now].
      -b, --break=<minutes>       the amount of minutes between each Pomodori [default: 5].
      -l, --long-break=<minutes>  the amount of minutes between every four Pomodori [default: 15].
      -p, --pomodoro=<minutes>    the amount of minutes for every pomodoro session [default: 25].
      -g, --group=<pomodori>      the amount of pomodori before a long break [default: 4].
      -j, --json                  output the pomodori schedule in JSON format.
      -n, --nocolour              do not colourise the output.
      -a, --amount                specify that the end time is the number of pomodoros you desire to do, not the time of a day.
      -x, --extensive-report      also write total break time and total session time.

Licence

Copyright © 2023 Matthew Stevens, released under the ISC Licence.