sepandhaghighi / mytimer

A Geeky Timer for Terminal Enthusiasts

MyTimer: A Geeky Timer for Terminal Enthusiasts

Table of contents

• Overview
• Installation
• Usage
• Issues & Bug Reports
• Contribution
• References
• Authors
• License
• Show Your Support
• Changelog
• Code of Conduct

Overview

MyTimer is a Python project that aims to provide a simple yet efficient timer for terminal users, particularly targeting the geek community. This project allows users to set timers directly from their command line interface, making it convenient for those who spend a significant amount of time working in the terminal!

The main objective of MyTimer is to offer a minimalistic and distraction-free timer experience. It provides a clean and straightforward interface, ensuring that users can focus solely on tracking time without any unnecessary clutter or distractions.

PyPI Counter
Github Stars

Branch	main	dev
CI

Code Quality

Installation

Source Code

• Download Version 1.2 or Latest Source
• pip install .

PyPI

• Check Python Packaging User Guide
• pip install mytimer==1.2

Usage

⚠️ You can use mytimer or python -m mytimer to run this program

Version

mytimer --version

Basic

⚠️ Press Ctrl + C to exit

mytimer

Time Limit

mytimer --minute=7 --second=30

mytimer --hour=2 --minute=20

Timer Mode

⚠️ The default mode is count-up

mytimer --minute=7 --second=30 --countdown

mytimer --minute=7 --second=30 --countup

Alarm

⚠️ This mode may not be supported on all systems

mytimer --minute=7 --second=30 --alarm

Alarm Repeat

⚠️ The default value is 1

mytimer --minute=7 --second=30 --alarm --alarm-repeat=5

Tone

⚠️ The default tone is 1

mytimer --minute=7 --second=30 --alarm --tone=2

• Tones List

Face

mytimer --minute=7 --second=30 --face=3

• Faces List
• mytimer --faces-list

Vertical/Horizontal shift

⚠️ The vertical and horizontal shift both have default values of 0

mytimer --v-shift=20 --h-shift=30

Program

mytimer --program=black-tea

• Programs List
• mytimer --programs-list

Message

mytimer --minute=7 --second=30 --message="Test message"

Screen Record

Issues & Bug Reports

Just fill an issue and describe it. We'll check it ASAP!

• Please complete the issue template

References

1- Mixkit Free Alarm Sound Effects

2- Online Timer

3- Media College

4- Pomodoro Technique

5- The Rule of 52 and 17: It's Random, But it Ups Your Productivity

6- Desktime’s Productivity Research: An Overview of Our Finds Throughout the Years

Show your support

Star this repo

Give a ⭐️ if this project helped you!

Donate to our project

Bitcoin

1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy

Ethereum

0xcD4Db18B6664A9662123D4307B074aE968535388

Litecoin

Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ

Doge

DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh

Tron

TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7

Ripple

rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq

Binance Coin

bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef

Tether

0xcD4Db18B6664A9662123D4307B074aE968535388

Dash

Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s

Stellar

GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL

Zilliqa

zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5

Coffeete

mytimer's Issues

Alarm ringtones

Description

Add different alarm ringtones

Add alarm-repeat

Description

Add alarm-repeat argument

Add continue

Description

Add continue flag in countdown mode

[Feature]: AnimeDoro program

Describe the feature you want to add

AnimeDoro timer:

1. Work for 40 to 60 minutes
2. Watch an episode of Anime for 20 minutes

Describe your proposed solution

No response

Describe alternatives you've considered, if relevant

No response

Additional context

References:

1. https://flocus.com/animedoro-timer/
2. https://ankushkun.github.io/animedoro-timer/Animedoro/
3. https://otakufy.live/

Input type

Description

hour, minute, and second types should be int

Enter `q` or `q+enter` to quit (new feature)

Description

This is a suggestion for new feature. Implement a feature so that the program terminates by entering q+enter or just a q, instead of ctrl+c.

Python 3.12 support

Description

Python 3.12 support

Add version flag

Description

Add version flag to mytimer.

Example:

mytimer --version

Add `noodle` program

Description

Add Noodle program

"noodle": {
        "hour": 0,
        "minute": 3,
        "second": 0,
        "alarm": 1,
        "alarm_repeat": 1,
        "face": 1,
        "tone": 1,
        "message": "Instant noodle (3 mins)"}

Add 4 new faces

Description

4 new faces:

1. dotmatrix
2. 3-d
3. sweet
4. epic

`japanese-green-tea` bug

Description

There seems to be an issue with the japanese-green-tea program.

Steps/Code to Reproduce

mytimer --program=japanese-green-tea

Expected Behavior

Work without problem

Actual Behavior

Traceback (most recent call last):
    ...
TypeError: inner_function() missing 1 required positional argument: 'tone'

Operating System

Windows 10

Python Version

3.8.2

MyTimer Version

MyTimer v0.9

Tone bug

Description

It seems some tones are too short and is not possible to hear them!!

Steps/Code to Reproduce

mytimer --second=2 --alarm --tone=4

Expected Behavior

Alarm

Actual Behavior

No alarm

Operating System

Windows 10

Python Version

Python 3.8

MyTimer Version

0.7

Move the timer to the centre of the terminal window (new feature)

Description

Since the timer is using all of the terminal window, it would look nicer if it is in the centre of the window and the rest of the display is not wasted.

Add message

Description

Add message parameter

Add `programs-list` argument

Description

Add --programs-list argument to show the list of programs.
Something like this:

mytimer --programs-list

1. `poached-egg` - Poached egg (1.5 mins)
2. `boiled-egg` - Boiled egg (3 mins)
.
.
.

Add new faces

Description

Add new faces to mytimer

Add programs

Description

Add different programs

Steps/Code to Reproduce

mytimer --program="green tea"

The timer doesn't really works

Description

The timer is not correct. It fails counting time.
Launching a 20 minutes timer takes 19 minutes and 41 seconds instead of 20 minutes

Steps/Code to Reproduce

You can try this :

$ time mytimer --minute=20

Expected Behavior

We must get something like this :

mytimer --minute=20  2.36s user 0.99s system 0% cpu 20:00.00 total

Actual Behavior

When testing I got this :

mytimer --minute=20 --countdown  2.36s user 0.99s system 0% cpu 19:41.35 total

Add `work`/`break` programs

Description

Add work, short-break, and long-break programs.

"work": {
        "hour": 0,
        "minute": 25,
        "second": 0,
        "alarm": 1,
        "alarm_repeat": 1,
        "face": 1,
        "tone": 1,
        "message": "Time to Work (25 mins)"}

"short-break": {
        "hour": 0,
        "minute": 10,
        "second": 0,
        "alarm": 1,
        "alarm_repeat": 1,
        "face": 1,
        "tone": 1,
        "message": "Short Break (10 mins)"}

"long-break": {
        "hour": 0,
        "minute": 30,
        "second": 0,
        "alarm": 1,
        "alarm_repeat": 1,
        "face": 1,
        "tone": 1,
        "message": "Long Break (30 mins)"}

Auto alignment

Description

The feature of auto alignment adjusts the layout of the display based on the size of the terminal.

Add `pomodoro` program

Description

Add the Pomodoro timer program

1. work program
2. short-break program
3. Go back to step 1 and repeat 4 times
4. long-break program

Add `52/17` program

Description

Add 52/17 program

Reference:

1. https://en.wikipedia.org/wiki/52/17_rule

Logo

Description

New logo

Add `v-shift` and `h-shift` arguments

Description

Add vertical/horizontal shift

Steps/Code to Reproduce

mytimer --v-shift=20 --h-shift=30

Expected Behavior

The starting position of the timer should be (30, 20).

Add `faces-list` argument

Description

Add --faces-list argument to show all faces with a sample.
Something like this:

mytimer --faces-list

Code: 1

 __  ___         ___   __         ___   _    
/  )(__ \   ()  (__ ) /. |   ()  | __) / )   
 )(  / _/        (_ \(_  _)      |__ \/ _ \  
(__)(____)  ()  (___/  (_)   ()  (___/\___/  

=============================================================================
Code: 2

 ,--.  ,---.           ,----.    ,---.          ,-----.   ,--.    
/   | '.-.  \   .--.   '.-.  |  /    |   .--.   |  .--'  /  .'    
`|  |  .-' .'   '--'     .' <  /  '  |   '--'   '--. `\ |  .-.    
 |  | /   '-.   .--.   /'-'  | '--|  |   .--.   .--'  / \   o |   
 `--' '-----'   '--'   `----'     `--'   '--'   `----'   `---'    

.
.
.

Zero padding

Description

Print 01:02:23 instead of 1:2:23
To avoid display stretching, implementing this solution will prove to be helpful.

Add `112/26` program

Description

Add 112/26 program

Reference:

1. https://desktime.com/blog/productivity-research