Awesome Open Source
Awesome Open Source

pydoro πŸ…

Terminal Pomodoro Timer

.. image::

.. Repo Badges

.. image:: :alt: PyPI :target: .. image:: :alt: CI :target: .. image:: :alt: Python Support :target: .. image:: :alt: Chat :target: .. image:: :target:

Installation πŸŽ‰

Install via pip:

.. code-block::

$ pip install pydoro
$ pydoro


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

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

For some systems you may have to use :code: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:

.. code-block::

$ pipx install pydoro

Usage πŸ“–

  • Run :code:pydoro to launch. More info in wiki_.

.. image::

.. _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
  • - For playing audio file, Copyright (c) 2016 Taylor_ Marks
  • prompt-toolkit - Awesome TUI library 😎
  • b15.wav - Dana_ robinson designs, CC0 from freesound

.. _releases: .. _Taylor: .. _Dana:

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_

.. _gmelodie: .. _requiem: .. _kajpio: .. _xr09: .. _islander: .. _beatrizuezu: .. _zlatsic: .. _nikamura: .. _akeerio:

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 🐍.

.. _Pomodoro Technique:

Copyright βš–

This software is Copyright (c) 2020 Bhathiya Perera.

See the LICENSE file for more information.

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
python (46,960)Β 
productivity (208)Β 
terminal-based (48)Β 
terminal-app (27)Β 
pomodoro (24)Β 

Find Open Source By Browsing 7,000 Topics Across 59 Categories