mytimer 2.3__tar.gz → 2.4__tar.gz

{mytimer-2.3 → mytimer-2.4}/CHANGELOG.md

@@ -5,6 +5,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [2.4] - 2025-12-04
+### Added
+- `--color` argument
+- `--bg-color` argument
+### Changed
+- `load_program_params` function modified
+- `pomodoro_timer` function modified
+- `two_step_timer` function modified
+- `select_timer_func` function renamed to `select_timer_function`
+- `mytimer_info` function renamed to `print_mytimer_info`
+- `run_timer` function modified
+- `Python 3.14` added to `test.yml`
+- `README.md` updated
+- Test system modified
 ## [2.3] - 2025-07-17
 ### Added
 - 2 new programs
@@ -230,7 +244,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Count-up mode
 - Alarm
 
-[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.3...dev
+[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.4...dev
+[2.4]: https://github.com/sepandhaghighi/mytimer/compare/v2.3...v2.4
 [2.3]: https://github.com/sepandhaghighi/mytimer/compare/v2.2...v2.3
 [2.2]: https://github.com/sepandhaghighi/mytimer/compare/v2.1...v2.2
 [2.1]: https://github.com/sepandhaghighi/mytimer/compare/v2.0...v2.1

{mytimer-2.3 → mytimer-2.4}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: mytimer
-Version: 2.3
+Version: 2.4
 Summary: A Geeky Timer for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/mytimer
-Download-URL: https://github.com/sepandhaghighi/mytimer/tarball/v2.3
+Download-URL: https://github.com/sepandhaghighi/mytimer/tarball/v2.4
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: End Users/Desktop
@@ -33,6 +34,7 @@ License-File: AUTHORS.md
 Requires-Dist: art>=5.3
 Requires-Dist: jdatetime>=3.8.2
 Requires-Dist: nava>=0.4
+Requires-Dist: colorama>=0.4.5
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -105,13 +107,13 @@ The main objective of <strong>MyTimer</strong> is to offer a minimalistic and di
 ## Installation		
 
 ### Source Code
-- Download [Version 2.3](https://github.com/sepandhaghighi/mytimer/archive/v2.3.zip) or [Latest Source](https://github.com/sepandhaghighi/mytimer/archive/dev.zip)
+- Download [Version 2.4](https://github.com/sepandhaghighi/mytimer/archive/v2.4.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.3`						
+- `pip install mytimer==2.4`						
 
 
 ## Usage
@@ -288,6 +290,26 @@ mytimer --program=black-tea
 mytimer --minute=7 --second=30 --message="Test message"
 ```
 
+### Color
+
+ℹ️ Valid choices: [`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`]
+
+ℹ️ The default color is `white`
+
+```console
+mytimer --minute=7 --second=30 --color="red"
+```
+
+### Background Color
+
+ℹ️ Valid choices: [`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`]
+
+ℹ️ The default background color is `black`
+
+```console
+mytimer --minute=7 --second=30 --bg-color="blue"
+```
+
 ## Screen Record
 
 <div align="center">
@@ -374,6 +396,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [2.4] - 2025-12-04
+### Added
+- `--color` argument
+- `--bg-color` argument
+### Changed
+- `load_program_params` function modified
+- `pomodoro_timer` function modified
+- `two_step_timer` function modified
+- `select_timer_func` function renamed to `select_timer_function`
+- `mytimer_info` function renamed to `print_mytimer_info`
+- `run_timer` function modified
+- `Python 3.14` added to `test.yml`
+- `README.md` updated
+- Test system modified
 ## [2.3] - 2025-07-17
 ### Added
 - 2 new programs
@@ -599,7 +635,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Count-up mode
 - Alarm
 
-[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.3...dev
+[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.4...dev
+[2.4]: https://github.com/sepandhaghighi/mytimer/compare/v2.3...v2.4
 [2.3]: https://github.com/sepandhaghighi/mytimer/compare/v2.2...v2.3
 [2.2]: https://github.com/sepandhaghighi/mytimer/compare/v2.1...v2.2
 [2.1]: https://github.com/sepandhaghighi/mytimer/compare/v2.0...v2.1

{mytimer-2.3 → mytimer-2.4}/README.md

@@ -54,13 +54,13 @@ The main objective of <strong>MyTimer</strong> is to offer a minimalistic and di
 ## Installation		
 
 ### Source Code
-- Download [Version 2.3](https://github.com/sepandhaghighi/mytimer/archive/v2.3.zip) or [Latest Source](https://github.com/sepandhaghighi/mytimer/archive/dev.zip)
+- Download [Version 2.4](https://github.com/sepandhaghighi/mytimer/archive/v2.4.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.3`						
+- `pip install mytimer==2.4`						
 
 
 ## Usage
@@ -237,6 +237,26 @@ mytimer --program=black-tea
 mytimer --minute=7 --second=30 --message="Test message"
 ```
 
+### Color
+
+ℹ️ Valid choices: [`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`]
+
+ℹ️ The default color is `white`
+
+```console
+mytimer --minute=7 --second=30 --color="red"
+```
+
+### Background Color
+
+ℹ️ Valid choices: [`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`]
+
+ℹ️ The default background color is `black`
+
+```console
+mytimer --minute=7 --second=30 --bg-color="blue"
+```
+
 ## Screen Record
 
 <div align="center">

{mytimer-2.3 → mytimer-2.4}/SECURITY.md

@@ -4,8 +4,8 @@
 
 | Version       | Supported          |
 | ------------- | ------------------ |
-| 2.3           | :white_check_mark: |
-| < 2.3         | :x:                |
+| 2.4           | :white_check_mark: |
+| < 2.4         | :x:                |
 
 ## Reporting a Vulnerability
 

{mytimer-2.3 → mytimer-2.4}/dev-requirements.txt

@@ -1,6 +1,7 @@
 nava==0.7
 art==6.5
 jdatetime==5.2.0
+colorama==0.4.6
 setuptools>=40.8.0
 vulture>=1.0
 bandit>=1.5.1

{mytimer-2.3 → mytimer-2.4}/mytimer/__main__.py

@@ -2,7 +2,7 @@
 """mytimer main."""
 from mytimer.params import FACES_LIST, PROGRAMS_MAP, TONES_LIST
 from mytimer.params import EXIT_MESSAGE, ADDITIONAL_INFO, SIGNS_LIST
-from mytimer.params import DATE_SYSTEMS_LIST
+from mytimer.params import DATE_SYSTEMS_LIST, COLORS_LIST
 from mytimer.functions import run_timer
 import argparse
 
@@ -20,6 +20,16 @@ def main() -> None:
         help='face',
         type=int,
         choices=FACES_LIST)
+    parser.add_argument(
+        '--color',
+        help='text color',
+        type=str.lower,
+        choices=COLORS_LIST)
+    parser.add_argument(
+        '--bg-color',
+        help='background color',
+        type=str.lower,
+        choices=COLORS_LIST)
     parser.add_argument(
         '--tone',
         help='alarm tone',

{mytimer-2.3 → mytimer-2.4}/mytimer/functions.py

@@ -9,6 +9,7 @@ import jdatetime
 import random
 import argparse
 from nava import play
+from colorama import Fore, Back
 from mytimer.params import INPUT_ERROR_MESSAGE, SOUND_ERROR_MESSAGE
 from mytimer.params import INPUT_EXAMPLE, TIME_ELEMENTS, MESSAGE_TEMPLATE
 from mytimer.params import FACES_MAP, PROGRAMS_MAP, BREAKS_MAP, TONES_MAP
@@ -38,15 +39,15 @@ def print_message(
     :param h_shift: horizontal shift
     :param confirm: confirm flag
     """
-    func = print
+    function = print
     if confirm:
-        func = input
+        function = input
     print('\n' * v_shift, end='')
-    func(h_shift * " " + message)
+    function(h_shift * " " + message)
 
 
-def mytimer_info() -> None:
-    """Print mytimer details."""
+def print_mytimer_info() -> None:
+    """Print mytimer info."""
     tprint("MyTimer")
     tprint("V:" + MY_TIMER_VERSION)
     print(MY_TIMER_OVERVIEW)
@@ -61,16 +62,16 @@ def load_program_params(program_name: str, is_break: bool = False) -> Dict[str,
     :param is_break: break flag
     """
     program_params = dict()
-    ref_map = PROGRAMS_MAP
-    ref_defaults = PROGRAMS_DEFAULTS
+    reference_map = PROGRAMS_MAP
+    reference_defaults = PROGRAMS_DEFAULTS
     if is_break:
-        ref_map = BREAKS_MAP
-        ref_defaults = BREAKS_DEFAULTS
+        reference_map = BREAKS_MAP
+        reference_defaults = BREAKS_DEFAULTS
     for item in DEFAULT_PARAMS:
-        if item in ref_map[program_name]:
-            program_params[item] = ref_map[program_name][item]
-        elif item in ref_defaults:
-            program_params[item] = ref_defaults[item]
+        if item in reference_map[program_name]:
+            program_params[item] = reference_map[program_name][item]
+        elif item in reference_defaults:
+            program_params[item] = reference_defaults[item]
         else:
             program_params[item] = DEFAULT_PARAMS[item]
     return program_params
@@ -131,11 +132,11 @@ def load_params(args: argparse.Namespace, program: str = None, is_break: bool =
     return params
 
 
-def input_handler(func: Callable) -> Callable:
+def input_handler(function: Callable) -> Callable:
     """
     Input handler decorator for timer functions.
 
-    :param func: input function
+    :param function: input function
     """
     def inner_function(
             hour: int,
@@ -189,7 +190,7 @@ def input_handler(func: Callable) -> Callable:
             if minute >= 60:
                 hour += minute // 60
                 minute %= 60
-            func(
+            function(
                 hour,
                 minute,
                 second,
@@ -230,6 +231,28 @@ def get_face(index: int) -> str:
     return FACES_MAP[index]
 
 
+def set_color(color: str) -> None:
+    """
+    Set text color.
+
+    :param color: color name
+    """
+    if color:
+        color = color.strip().upper()
+        print(getattr(Fore, color, ""), end="")
+
+
+def set_bg_color(bg_color: str) -> None:
+    """
+    Set background color.
+
+    :param bg_color: background color name
+    """
+    if bg_color:
+        bg_color = bg_color.strip().upper()
+        print(getattr(Back, bg_color, ""), end="")
+
+
 def get_tone(index: int) -> str:
     """
     Return tone file name.
@@ -466,14 +489,14 @@ def countdown_timer(
 
 
 def pomodoro_timer(
-        timer_func: Callable,
+        timer_function: Callable,
         params: Dict[str, Any],
         long_break_params: Dict[str, Any],
         short_break_params: Dict[str, Any]) -> None:
     """
     Pomodoro timer function.
 
-    :param timer_func: timer function
+    :param timer_function: timer function
     :param params: program params
     :param long_break_params: long break params
     :param short_break_params: short break params
@@ -482,29 +505,29 @@ def pomodoro_timer(
     for index in range(4):
         work_params = params.copy()
         work_params["message"] += " {round}/{repeat}".format(round=index + 1, repeat=4)
-        timer_func(**work_params)
+        timer_function(**work_params)
         if index == 3:
             break
         print_message(message=NEXT_PROGRAM_MESSAGE.format(next_program="Short break"), h_shift=h_shift, confirm=True)
-        timer_func(**short_break_params)
+        timer_function(**short_break_params)
         print_message(message=NEXT_PROGRAM_MESSAGE.format(
             next_program="Work {round}/{repeat}".format(round=index + 2, repeat=4)), h_shift=h_shift, confirm=True)
     print_message(message=NEXT_PROGRAM_MESSAGE.format(next_program="Long break"), h_shift=h_shift, confirm=True)
-    timer_func(**long_break_params)
+    timer_function(**long_break_params)
 
 
-def two_step_timer(timer_func: Callable, params1: Dict[str, Any], params2: Dict[str, Any]) -> None:
+def two_step_timer(timer_function: Callable, params1: Dict[str, Any], params2: Dict[str, Any]) -> None:
     """
     Two step timer function.
 
-    :param timer_func: timer function
+    :param timer_function: timer function
     :param params1: program-1 params
     :param params2: program-2 params
     """
     h_shift = params1["h_shift"]
-    timer_func(**params1)
+    timer_function(**params1)
     print_message(message=NEXT_PROGRAM_MESSAGE.format(next_program="Break"), h_shift=h_shift, confirm=True)
-    timer_func(**params2)
+    timer_function(**params2)
 
 
 def keep_on_timer(params: Dict[str, Any]) -> None:
@@ -547,23 +570,23 @@ def update_set_on_params(params: Dict[str, Any]) -> Dict[str, Any]:
     return params
 
 
-def select_timer_func(args: argparse.Namespace, params: Dict[str, Any]) -> Tuple[Callable, Dict[str, Any]]:
+def select_timer_function(args: argparse.Namespace, params: Dict[str, Any]) -> Tuple[Callable, Dict[str, Any]]:
     """
     Select timer function and parameters.
 
     :param args: input arguments
     :param params: timer params
     """
-    timer_func = countdown_timer
+    timer_function = countdown_timer
     if args.countup:
-        timer_func = countup_timer
+        timer_function = countup_timer
     if args.countdown:
-        timer_func = countdown_timer
+        timer_function = countdown_timer
     else:
         if check_null_time(args) and not args.program:
             params["hour"] = KEEP_ON_MAX
-            timer_func = countup_timer
-    return timer_func, params
+            timer_function = countup_timer
+    return timer_function, params
 
 
 def run_timer(args: argparse.Namespace) -> None:
@@ -572,14 +595,16 @@ def run_timer(args: argparse.Namespace) -> None:
 
     :param args: input arguments
     """
+    set_color(color=args.color)
+    set_bg_color(bg_color=args.bg_color)
     params = load_params(args)
-    timer_func, params = select_timer_func(args, params)
+    timer_function, params = select_timer_function(args, params)
     if args.set_on:
         params = update_set_on_params(params)
     if args.version:
         print(MY_TIMER_VERSION)
     elif args.info:
-        mytimer_info()
+        print_mytimer_info()
     elif args.faces_list:
         show_faces_list()
     elif args.programs_list:
@@ -593,15 +618,15 @@ def run_timer(args: argparse.Namespace) -> None:
                 short_break_params = load_params(args, program="pomodoro-short-break", is_break=True)
                 long_break_params = load_params(args, program="pomodoro-long-break", is_break=True)
                 pomodoro_timer(
-                    timer_func,
+                    timer_function,
                     params=params,
                     long_break_params=long_break_params,
                     short_break_params=short_break_params)
             elif args.program in ["52-17", "112-26", "animedoro"]:
                 break_params = load_params(args, is_break=True)
-                two_step_timer(timer_func, params1=params, params2=break_params)
+                two_step_timer(timer_function, params1=params, params2=break_params)
             else:
-                timer_func(**params)
+                timer_function(**params)
             end_round_message = END_ROUND_MESSAGE.format(
                 round="{round}/{repeat}".format(round=timer_round, repeat=args.repeat))
             if args.repeat == -1:

{mytimer-2.3 → mytimer-2.4}/mytimer/params.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """mytimer params."""
 
-MY_TIMER_VERSION = "2.3"
+MY_TIMER_VERSION = "2.4"
 ADDITIONAL_INFO = "Additional information: Press `Ctrl+C` to exit."
 INPUT_ERROR_MESSAGE = "[Error] Wrong input"
 SOUND_ERROR_MESSAGE = "[Error] Unable to play sound"
@@ -359,3 +359,14 @@ FACES_LIST = [-1] + sorted(FACES_MAP)
 TONES_LIST = [-1] + sorted(TONES_MAP)
 
 DATE_SYSTEMS_LIST = ["gregorian", "jalali"]
+
+COLORS_LIST = [
+    "black",
+    "red",
+    "green",
+    "yellow",
+    "blue",
+    "magenta",
+    "cyan",
+    "white",
+]

{mytimer-2.3 → mytimer-2.4}/mytimer.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: mytimer
-Version: 2.3
+Version: 2.4
 Summary: A Geeky Timer for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/mytimer
-Download-URL: https://github.com/sepandhaghighi/mytimer/tarball/v2.3
+Download-URL: https://github.com/sepandhaghighi/mytimer/tarball/v2.4
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Education
 Classifier: Intended Audience :: End Users/Desktop
@@ -33,6 +34,7 @@ License-File: AUTHORS.md
 Requires-Dist: art>=5.3
 Requires-Dist: jdatetime>=3.8.2
 Requires-Dist: nava>=0.4
+Requires-Dist: colorama>=0.4.5
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -105,13 +107,13 @@ The main objective of <strong>MyTimer</strong> is to offer a minimalistic and di
 ## Installation		
 
 ### Source Code
-- Download [Version 2.3](https://github.com/sepandhaghighi/mytimer/archive/v2.3.zip) or [Latest Source](https://github.com/sepandhaghighi/mytimer/archive/dev.zip)
+- Download [Version 2.4](https://github.com/sepandhaghighi/mytimer/archive/v2.4.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.3`						
+- `pip install mytimer==2.4`						
 
 
 ## Usage
@@ -288,6 +290,26 @@ mytimer --program=black-tea
 mytimer --minute=7 --second=30 --message="Test message"
 ```
 
+### Color
+
+ℹ️ Valid choices: [`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`]
+
+ℹ️ The default color is `white`
+
+```console
+mytimer --minute=7 --second=30 --color="red"
+```
+
+### Background Color
+
+ℹ️ Valid choices: [`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`]
+
+ℹ️ The default background color is `black`
+
+```console
+mytimer --minute=7 --second=30 --bg-color="blue"
+```
+
 ## Screen Record
 
 <div align="center">
@@ -374,6 +396,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [2.4] - 2025-12-04
+### Added
+- `--color` argument
+- `--bg-color` argument
+### Changed
+- `load_program_params` function modified
+- `pomodoro_timer` function modified
+- `two_step_timer` function modified
+- `select_timer_func` function renamed to `select_timer_function`
+- `mytimer_info` function renamed to `print_mytimer_info`
+- `run_timer` function modified
+- `Python 3.14` added to `test.yml`
+- `README.md` updated
+- Test system modified
 ## [2.3] - 2025-07-17
 ### Added
 - 2 new programs
@@ -599,7 +635,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Count-up mode
 - Alarm
 
-[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.3...dev
+[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.4...dev
+[2.4]: https://github.com/sepandhaghighi/mytimer/compare/v2.3...v2.4
 [2.3]: https://github.com/sepandhaghighi/mytimer/compare/v2.2...v2.3
 [2.2]: https://github.com/sepandhaghighi/mytimer/compare/v2.1...v2.2
 [2.1]: https://github.com/sepandhaghighi/mytimer/compare/v2.0...v2.1

{mytimer-2.3 → mytimer-2.4}/mytimer.egg-info/requires.txt

@@ -1,3 +1,4 @@
 art>=5.3
 jdatetime>=3.8.2
 nava>=0.4
+colorama>=0.4.5

{mytimer-2.3 → mytimer-2.4}/requirements.txt

@@ -1,3 +1,4 @@
 art>=5.3
 jdatetime>=3.8.2
 nava>=0.4
+colorama>=0.4.5

{mytimer-2.3 → mytimer-2.4}/setup.py

@@ -30,7 +30,7 @@ def read_description() -> str:
 setup(
     name='mytimer',
     packages=['mytimer'],
-    version='2.3',
+    version='2.4',
     description='A Geeky Timer for Terminal Enthusiasts',
     long_description=read_description(),
     long_description_content_type='text/markdown',
@@ -38,7 +38,7 @@ setup(
     author='Sepand Haghighi',
     author_email='me@sepand.tech',
     url='https://github.com/sepandhaghighi/mytimer',
-    download_url='https://github.com/sepandhaghighi/mytimer/tarball/v2.3',
+    download_url='https://github.com/sepandhaghighi/mytimer/tarball/v2.4',
     keywords="timer time clock terminal stopwatch cli geek",
     project_urls={
         'Source': 'https://github.com/sepandhaghighi/mytimer'
@@ -57,6 +57,7 @@ setup(
         'Programming Language :: Python :: 3.11',
         'Programming Language :: Python :: 3.12',
         'Programming Language :: Python :: 3.13',
+        'Programming Language :: Python :: 3.14',
         'Intended Audience :: Developers',
         'Intended Audience :: Education',
         'Intended Audience :: End Users/Desktop',