Skip to main content
PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Terminal Pomodoro Timer

Project description

Terminal Pomodoro Timer

https://github.com/JaDogg/pydoro/raw/develop/images/logo.png PyPI CI Python Support Chat https://img.shields.io/badge/code%20style-black-000000.svg

Installation 🎉

Install via pip:

$ pip install pydoro
$ pydoro

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

Usage 📖

  • Run pydoro to launch. More info in wiki.

https://github.com/JaDogg/pydoro/raw/develop/images/animation.gif

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 🙏

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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page