scopeta / focusedme

A minimalist Pomodoro timer that runs in your terminal

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

focusedMe

https://travis-ci.com/scopeta/focusedme.svg?branch=master Documentation Status

A minimalist Pomodoro timer that runs in your terminal

Installation and usage

Install via pip
$ pip install focusedme
Read instructions
$ focusedme -h
Common usage (default pomodoro values)
$ focusedme

https://raw.githubusercontent.com/scopeta/focusedme/master/docs/images/UI.png

Overview

Project Background and Description

The goal of this project is to implement a productivity timer based on Pomodoro technique using Python programming language

The focusedMe module implements the basic features of a Pomodoro timer that runs in a terminal and provide a minimalist text-based interface. The timer provides an easy way to break down work into focused sessions, traditionally 25 minutes in length, separated by short or long breaks. Each session is known as a Pomodoro.

The timer tracks the sessions and notify the user of completion, as well as allow them to control its progress.

Features

The timer currently includes the following features:

  • Allows users to initialize the timer with default parameters (25 mins for focused sessions and long breaks, and 5 mins for short breaks)
  • Tracks sessions according the Pomodoro technique and properly handling short and long breaks
  • Updates the user in real time through a text-based interface
  • Includes command line help and user options in the screen
  • Plays a sound to alert the user when a session is completed and a new one is about to start
  • Allows user to skip or pause a session or stop timer
  • Allows user to visualize information about progress

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

JaDogg_: for the in_app_path function in util.py module

TaylorSMarks: for the playsound module

About

A minimalist Pomodoro timer that runs in your terminal

License:MIT License


Languages

Language:Python 90.1%Language:Makefile 9.9%