Git Product home page Git Product logo

focusedme's Introduction

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

focusedme's People

Contributors

scopeta avatar arthurcn96 avatar guilhermeslucas avatar dependabot[bot] avatar

Stargazers

Onam Hernandez avatar gdnkei0 avatar Ricardo Squassina Lee avatar  avatar  avatar

Watchers

James Cloos avatar  avatar

focusedme's Issues

Write tests

I was taking a look at the repo and noticed you have a file called tests that doesn't have tests yet! Do you want some help writing them? I would be happy to help! Thanks!

Add test automation including Test Pypi continuous delivery

  • focusedMe version:
  • Python version:
  • Operating System:

Description

Describe what you were trying to get done.
Tell us what happened, what went wrong, and what you expected to happen.

What I Did

Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.

enhance progression graphic

Description

Use visualization library to plot progress

Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.