https://github.com/sepandhaghighi/mytimer
A Geeky Timer for Terminal Enthusiasts
https://github.com/sepandhaghighi/mytimer
cli console console-app console-application counter geek pomodoro pomodoro-technique pomodoro-timer python stopwatch terminal terminal-app terminal-based time-management timer
Last synced: 6 months ago
JSON representation
A Geeky Timer for Terminal Enthusiasts
- Host: GitHub
- URL: https://github.com/sepandhaghighi/mytimer
- Owner: sepandhaghighi
- License: mit
- Created: 2022-10-13T21:51:09.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-28T19:59:36.000Z (11 months ago)
- Last Synced: 2024-11-29T09:14:04.256Z (11 months ago)
- Topics: cli, console, console-app, console-application, counter, geek, pomodoro, pomodoro-technique, pomodoro-timer, python, stopwatch, terminal, terminal-app, terminal-based, time-management, timer
- Language: Python
- Homepage:
- Size: 6.08 MB
- Stars: 108
- Watchers: 4
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Authors: AUTHORS.md
Awesome Lists containing this project
README
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.2](https://github.com/sepandhaghighi/mytimer/archive/v2.2.zip) or [Latest Source](https://github.com/sepandhaghighi/mytimer/archive/dev.zip)
- `pip install .`
### PyPI
- Check [Python Packaging User Guide](https://packaging.python.org/installing/)
- `pip install mytimer==2.2`
## Usage
ℹ️ You can use `mytimer` or `python -m mytimer` to run this program
### Version
```console
mytimer --version
```
### Info
```console
mytimer --info
```
### Basic
ℹ️ Press `Ctrl + C` to exit
```console
mytimer
```
### Time Limit
```console
mytimer --minute=7 --second=30
```
```console
mytimer --hour=2 --minute=20
```
### Timer Mode
ℹ️ The default mode is `countdown`
```console
mytimer --minute=7 --second=30 --countdown
```
```console
mytimer --minute=7 --second=30 --countup
```
### Repeat
ℹ️ The default value is `1`
```console
mytimer --repeat=3 --second=4
```
* Use `--repeat=-1` for infinite loop
### Alarm
⚠️ This mode may not be supported on all systems
```console
mytimer --minute=7 --second=30 --alarm
```
### Alarm Repeat
ℹ️ The default value is `1`
```console
mytimer --minute=7 --second=30 --alarm --alarm-repeat=5
```
### Tone
ℹ️ The default tone is `1`
```console
mytimer --minute=7 --second=30 --alarm --tone=2
```
* Use `--tone=-1` for random mode
* Use `--test-tone` for test
* [Tones List](https://github.com/sepandhaghighi/mytimer/blob/main/TONES.md)
### Face
```console
mytimer --minute=7 --second=30 --face=3
```
* Use `--face=-1` for random mode
* [Faces List](https://github.com/sepandhaghighi/mytimer/blob/main/FACES.md)
* `mytimer --faces-list`
### Vertical/Horizontal Shift
ℹ️ The vertical and horizontal shift both have default values of `0`
```console
mytimer --v-shift=20 --h-shift=30
```
### Timer Sign
ℹ️ Valid choices: [`""`, `"+"`, `"-"`]
```console
mytimer --sign="+"
```
### Keep on
In this mode, the timer will continue running after it times out
```console
mytimer --minute=5 --keep-on
```
### Hide Second
In this mode, the timer seconds counter will not be shown
```console
mytimer --minute=6 --hide-second
```
### Hide Date/Time
In this mode, the date/time will not be shown
```console
mytimer --minute=20 --hide-datetime
```
### Date System
ℹ️ Valid choices: [`gregorian`, `jalali`]
ℹ️ The default date system is `gregorian`
```console
mytimer --minute=20 --date-system=jalali
```
### Vertical Mode
```console
mytimer --minute=5 --vertical
```
### Set on
⚠️ Local time
In this mode, the timer sets on the given time. For example, here we set a timer for `15:05`.
```console
mytimer --hour=15 --minute=5 --set-on
```
### Program
```console
mytimer --program=black-tea
```
* [Programs List](https://github.com/sepandhaghighi/mytimer/blob/main/PROGRAMS.md)
* `mytimer --programs-list`
### Message
```console
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
7- AnimeDoro Timer
8- Know Your Tea: Your Guide to Tea Steeping Time
9- How Long to Steep Tea: A Complete Guide
10- How Long to Steep French Press: Mastering the Perfect Brew
11- Freesound
12- Online Timer with Alarm and Sound
## 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
