MyTimer: A Geeky Timer for Terminal Enthusiasts

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 2.5 or Latest Source
pip install .

PyPI

Check Python Packaging User Guide
pip install mytimer==2.5

Usage

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

Version

mytimer --version

Info

mytimer --info

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 countdown

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

Repeat
ℹ️ The default value is 1
mytimer --repeat=3 --second=4
</code></pre>
<ul>
<li>Use <code>--repeat=-1</code> for infinite loop</li>
</ul>
<h3>Alarm</h3>
<p>⚠️ This mode may not be supported on all systems</p>
<pre><code class="language-console">mytimer --minute=7 --second=30 --alarm
</code></pre>
<h3>Alarm Repeat</h3>
<p>ℹ️ The default value is <code>1</code></p>
<pre><code class="language-console">mytimer --minute=7 --second=30 --alarm --alarm-repeat=5
</code></pre>
<h3>Tone</h3>
<p>ℹ️ The default tone is <code>1</code></p>
<pre><code class="language-console">mytimer --minute=7 --second=30 --alarm --tone=2
</code></pre>
<ul>
<li>Use <code>--tone=-1</code> for random mode</li>
<li>Use <code>--test-tone</code> for test</li>
<li><a href="https://github.com/sepandhaghighi/mytimer/blob/main/TONES.md">Tones List</a></li>
</ul>
<h3>Face</h3>
<pre><code class="language-console">mytimer --minute=7 --second=30 --face=3
</code></pre>
<ul>
<li>Use <code>--face=-1</code> for random mode</li>
<li><a href="https://github.com/sepandhaghighi/mytimer/blob/main/FACES.md">Faces List</a></li>
<li><code>mytimer --faces-list</code></li>
</ul>
<h3>Vertical/Horizontal Shift</h3>
<p>ℹ️ The vertical and horizontal shift both have default values of <code>0</code></p>
<pre><code class="language-console">mytimer --v-shift=20 --h-shift=30
</code></pre>
<h3>Timer Sign</h3>
<p>ℹ️ Valid choices: [<code>&quot;&quot;</code>, <code>&quot;+&quot;</code>, <code>&quot;-&quot;</code>]</p>
<pre><code class="language-console">mytimer --sign=&quot;+&quot;
</code></pre>
<h3>Keep on</h3>
<p>In this mode, the timer will continue running after it times out</p>
<pre><code class="language-console">mytimer --minute=5 --keep-on
</code></pre>
<h3>Hide Second</h3>
<p>In this mode, the timer seconds counter will not be shown</p>
<pre><code class="language-console">mytimer --minute=6 --hide-second
</code></pre>
<h3>Hide Date/Time</h3>
<p>In this mode, the date/time will not be shown</p>
<pre><code class="language-console">mytimer --minute=20 --hide-datetime
</code></pre>
<h3>Date System</h3>
<p>ℹ️ Valid choices: [<code>gregorian</code>, <code>jalali</code>]</p>
<p>ℹ️ The default date system is <code>gregorian</code></p>
<pre><code class="language-console">mytimer --minute=20 --date-system=jalali
</code></pre>
<h3>Vertical Mode</h3>
<pre><code class="language-console">mytimer --minute=5 --vertical
</code></pre>
<h3>Set on</h3>
<p>⚠️ Local time</p>
<p>In this mode, the timer sets on the given time. For example, here we set a timer for <code>15:05</code>:</p>
<pre><code class="language-console">mytimer --hour=15 --minute=5 --set-on
</code></pre>
<h3>Program</h3>
<pre><code class="language-console">mytimer --program=black-tea
</code></pre>
<ul>
<li><a href="https://github.com/sepandhaghighi/mytimer/blob/main/PROGRAMS.md">Programs List</a></li>
<li><code>mytimer --programs-list</code></li>
</ul>
<h3>Message</h3>
<pre><code class="language-console">mytimer --minute=7 --second=30 --message=&quot;Test message&quot;
</code></pre>
<h3>Color</h3>
<p>⚠️ This mode may not be supported on all systems</p>
<p>ℹ️ Valid choices: [<code>black</code>, <code>red</code>, <code>green</code>, <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code>, <code>lightblack</code>, <code>lightred</code>, <code>lightgreen</code>, <code>lightyellow</code>, <code>lightblue</code>, <code>lightmagenta</code>, <code>lightcyan</code>, <code>lightwhite</code>]</p>
<p>ℹ️ The default color is <code>white</code></p>
<pre><code class="language-console">mytimer --minute=7 --second=30 --color=&quot;red&quot;
</code></pre>
<h3>Background Color</h3>
<p>⚠️ This mode may not be supported on all systems</p>
<p>ℹ️ Valid choices: [<code>black</code>, <code>red</code>, <code>green</code>, <code>yellow</code>, <code>blue</code>, <code>magenta</code>, <code>cyan</code>, <code>white</code>, <code>lightblack</code>, <code>lightred</code>, <code>lightgreen</code>, <code>lightyellow</code>, <code>lightblue</code>, <code>lightmagenta</code>, <code>lightcyan</code>, <code>lightwhite</code>]</p>
<p>ℹ️ The default background color is <code>black</code></p>
<pre><code class="language-console">mytimer --minute=7 --second=30 --bg-color=&quot;blue&quot;
</code></pre>
<h3>Intensity</h3>
<p>⚠️ This mode may not be supported on all systems</p>
<p>ℹ️ Valid choices: [<code>normal</code>, <code>bright</code>, <code>dim</code>]</p>
<p>ℹ️ The default intensity is <code>normal</code></p>
<pre><code class="language-console">mytimer --minute=7 --second=30 --intensity=&quot;bright&quot;
</code></pre>
<h2>Screen Record</h2>
<div align="center">

<img src="https://github.com/sepandhaghighi/mytimer/raw/main/otherfiles/help.gif">

</div>


<h2>Issues &amp; Bug Reports</h2>
<p>Just fill an issue and describe it. We&#39;ll check it ASAP!</p>
<ul>
<li>Please complete the issue template</li>
</ul>
<h2>References</h2>
<blockquote>1- <a href="https://mixkit.co/free-sound-effects/alarm/">Mixkit Free Alarm Sound Effects</a></blockquote>

<blockquote>2- <a href="https://www.online-timers.com/">Online Timer</a></blockquote>

<blockquote>3- <a href="https://www.mediacollege.com/">Media College</a></blockquote>

<blockquote>4- <a href="https://en.wikipedia.org/wiki/Pomodoro_Technique">Pomodoro Technique</a></blockquote>

<blockquote>5- <a href="https://www.themuse.com/advice/the-rule-of-52-and-17-its-random-but-it-ups-your-productivity">The Rule of 52 and 17: It's Random, But it Ups Your Productivity</a></blockquote>

<blockquote>6- <a href="https://desktime.com/blog/productivity-research">Desktime’s Productivity Research: An Overview of Our Finds Throughout the Years</a></blockquote>

<blockquote>7- <a href="https://ankushkun.github.io/animedoro-timer/Animedoro/">AnimeDoro Timer</a></blockquote>

<blockquote>8- <a href="https://worldteadirectory.com/know-tea-guide-tea-steeping-time/">Know Your Tea: Your Guide to Tea Steeping Time</a></blockquote>

<blockquote>9- <a href="https://artfultea.com/blogs/101/loose-leaf-tea-steep-time">How Long to Steep Tea: A Complete Guide</a></blockquote>

<blockquote>10- <a href="https://majestycoffee.com/blogs/posts/how-long-to-steep">How Long to Steep French Press: Mastering the Perfect Brew</a></blockquote>

<blockquote>11- <a href="https://freesound.org">Freesound</a></blockquote>

<blockquote>12- <a href="https://www.online-timer.net/">Online Timer with Alarm and Sound</a></blockquote>


<h2>Show Your Support</h2>
<h3>Star This Repo</h3>					

<p>Give a ⭐️ if this project helped you!</p>
<h3>Donate to Our Project</h3>	

<h4>Bitcoin</h4>
1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy
<h4>Ethereum</h4>
0xcD4Db18B6664A9662123D4307B074aE968535388
<h4>Litecoin</h4>
Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ
<h4>Doge</h4>
DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh
<h4>Tron</h4>
TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7
<h4>Ripple</h4>
rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq
<h4>Binance Coin</h4>
bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef
<h4>Tether</h4>
0xcD4Db18B6664A9662123D4307B074aE968535388
<h4>Dash</h4>
Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s
<h4>Stellar</h4>		
GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL
<h4>Zilliqa</h4>
zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5
<h4>Coffeete</h4>
<a href="http://www.coffeete.ir/opensource">
<img src="http://www.coffeete.ir/images/buttons/lemonchiffon.png" style="width:260px;">
</a>

NAME

SYNOPSIS

INFO

DESCRIPTION

README