Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

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: about 2 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 (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-19T04:30:05.000Z (about 2 months ago)
Last Synced: 2024-04-19T05:29:38.720Z (about 2 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: 829 KB
Stars: 85
Watchers: 4
Forks: 5
Open Issues: 3
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
- Authors: AUTHORS.md

Lists

cli-apps - MyTimer - Simple timer for the terminal with timer-mode and alarm. (<a name="time-tracker"></a>Time trackers)
awesome-cli-apps - MyTimer - Simple timer for the terminal with timer-mode and alarm. (<a name="time-tracker"></a>Time trackers)

README

MyTimer: A Geeky Timer for Terminal Enthusiasts

## Table of contents
* [Overview](https://github.com/sepandhaghighi/mytimer#overview)
* [Installation](https://github.com/sepandhaghighi/mytimer#installation)
* [Usage](https://github.com/sepandhaghighi/mytimer#usage)
* [Issues & Bug Reports](https://github.com/sepandhaghighi/mytimer#issues--bug-reports)
* [Contribution](https://github.com/sepandhaghighi/mytimer/blob/main/.github/CONTRIBUTING.md)
* [References](https://github.com/sepandhaghighi/mytimer#references)
* [Authors](https://github.com/sepandhaghighi/mytimer/blob/main/AUTHORS.md)
* [License](https://github.com/sepandhaghighi/mytimer/blob/main/LICENSE)
* [Show Your Support](https://github.com/sepandhaghighi/mytimer#show-your-support)
* [Changelog](https://github.com/sepandhaghighi/mytimer/blob/main/CHANGELOG.md)
* [Code of Conduct](https://github.com/sepandhaghighi/mytimer/blob/main/.github/CODE_OF_CONDUCT.md)

## 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](https://github.com/sepandhaghighi/mytimer/archive/v1.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==1.2`

## Usage

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

### Version

```console
mytimer --version
```

### 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 `count-up`

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

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

### 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
```
* [Tones List](https://github.com/sepandhaghighi/mytimer/blob/main/TONES.md)

### Face

```console
mytimer --minute=7 --second=30 --face=3
```
* [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
```

### 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

## 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