mytimer 2.1__tar.gz → 2.2__tar.gz

{mytimer-2.1 → mytimer-2.2}/CHANGELOG.md

@@ -5,6 +5,15 @@ 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.2] - 2025-03-13
+### Added
+- `--date-system` argument
+### Changed
+- `README.md` updated
+- Test system modified
+- `countdown_timer` and `countup_timer` functions updated
+- String templates modified
+- Input case sensitivity bug fixed
 ## [2.1] - 2025-02-28
 ### Added
 - 4 new tones
@@ -209,7 +218,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.1...dev
+[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.2...dev
+[2.2]: https://github.com/sepandhaghighi/mytimer/compare/v2.1...v2.2
 [2.1]: https://github.com/sepandhaghighi/mytimer/compare/v2.0...v2.1
 [2.0]: https://github.com/sepandhaghighi/mytimer/compare/v1.9...v2.0
 [1.9]: https://github.com/sepandhaghighi/mytimer/compare/v1.8...v1.9

{mytimer-2.1 → mytimer-2.2}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.2
 Name: mytimer
-Version: 2.1
+Version: 2.2
 Summary: A Geeky Timer for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/mytimer
-Download-URL: https://github.com/sepandhaghighi/mytimer/tarball/v2.1
+Download-URL: https://github.com/sepandhaghighi/mytimer/tarball/v2.2
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -32,6 +32,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: art>=5.3
+Requires-Dist: jdatetime>=3.8.2
 Requires-Dist: nava>=0.4
 Dynamic: author
 Dynamic: author-email
@@ -105,13 +106,13 @@ The main objective of <strong>MyTimer</strong> is to offer a minimalistic and di
 ## Installation		
 
 ### Source Code
-- Download [Version 2.1](https://github.com/sepandhaghighi/mytimer/archive/v2.1.zip) or [Latest Source](https://github.com/sepandhaghighi/mytimer/archive/dev.zip)
+- 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.1`						
+- `pip install mytimer==2.2`						
 
 
 ## Usage
@@ -247,6 +248,16 @@ In this mode, the date/time will not be shown
 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
@@ -364,6 +375,15 @@ 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.2] - 2025-03-13
+### Added
+- `--date-system` argument
+### Changed
+- `README.md` updated
+- Test system modified
+- `countdown_timer` and `countup_timer` functions updated
+- String templates modified
+- Input case sensitivity bug fixed
 ## [2.1] - 2025-02-28
 ### Added
 - 4 new tones
@@ -568,7 +588,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.1...dev
+[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.2...dev
+[2.2]: https://github.com/sepandhaghighi/mytimer/compare/v2.1...v2.2
 [2.1]: https://github.com/sepandhaghighi/mytimer/compare/v2.0...v2.1
 [2.0]: https://github.com/sepandhaghighi/mytimer/compare/v1.9...v2.0
 [1.9]: https://github.com/sepandhaghighi/mytimer/compare/v1.8...v1.9

{mytimer-2.1 → mytimer-2.2}/README.md

@@ -55,13 +55,13 @@ The main objective of <strong>MyTimer</strong> is to offer a minimalistic and di
 ## Installation		
 
 ### Source Code
-- Download [Version 2.1](https://github.com/sepandhaghighi/mytimer/archive/v2.1.zip) or [Latest Source](https://github.com/sepandhaghighi/mytimer/archive/dev.zip)
+- 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.1`						
+- `pip install mytimer==2.2`						
 
 
 ## Usage
@@ -197,6 +197,16 @@ In this mode, the date/time will not be shown
 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-2.1 → mytimer-2.2}/SECURITY.md

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

{mytimer-2.1 → mytimer-2.2}/dev-requirements.txt

@@ -1,5 +1,6 @@
 nava==0.7
 art==6.4
+jdatetime==5.2.0
 setuptools>=40.8.0
 vulture>=1.0
 bandit>=1.5.1

{mytimer-2.1 → mytimer-2.2}/mytimer/__main__.py

@@ -2,6 +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.functions import run_timer
 import argparse
 
@@ -31,7 +32,7 @@ def main():
     parser.add_argument(
         '--program',
         help='program',
-        type=str,
+        type=str.lower,
         choices=sorted(PROGRAMS_MAP))
     parser.add_argument(
         '--sign',
@@ -58,6 +59,7 @@ def main():
     parser.add_argument('--hide-second', help='hide second', nargs="?", const=1)
     parser.add_argument('--hide-datetime', help='hide datetime', nargs="?", const=1)
     parser.add_argument('--vertical', help='vertical mode', nargs="?", const=1)
+    parser.add_argument('--date-system', help='date system', type=str.lower, choices=DATE_SYSTEMS_LIST, default="gregorian")
     parser.add_argument(
         '--programs-list',
         help='programs list',

{mytimer-2.1 → mytimer-2.2}/mytimer/functions.py

@@ -4,6 +4,7 @@ import os
 import sys
 import time
 import datetime
+import jdatetime
 import random
 from nava import play
 from mytimer.params import INPUT_ERROR_MESSAGE, SOUND_ERROR_MESSAGE
@@ -91,9 +92,9 @@ def show_programs_list():
     for i, program in enumerate(sorted(PROGRAMS_MAP), 1):
         print(
             PROGRAMS_LIST_TEMPLATE.format(
-                i,
-                program,
-                PROGRAMS_MAP[program]['message']))
+                index=i,
+                program=program,
+                message=PROGRAMS_MAP[program]['message']))
 
 
 def show_faces_list():
@@ -172,7 +173,8 @@ def input_handler(func):
             sign,
             hide_second,
             hide_datetime,
-            vertical):
+            vertical,
+            date_system):
         """
         Inner function.
 
@@ -204,11 +206,13 @@ def input_handler(func):
         :type hide_datetime: bool
         :param vertical: vertical mode flag
         :type vertical: bool
+        :param date_system: date system
+        :type date_system: str
         :return: None
         """
         message = message.strip()
         if len(message) > 0:
-            message = MESSAGE_TEMPLATE.format(message)
+            message = MESSAGE_TEMPLATE.format(message=message)
         if alarm_repeat < 1:
             alarm_repeat = DEFAULT_PARAMS["alarm_repeat"]
         if h_shift < 0:
@@ -237,7 +241,8 @@ def input_handler(func):
                 sign,
                 hide_second,
                 hide_datetime,
-                vertical)
+                vertical,
+                date_system)
         else:
             print(INPUT_ERROR_MESSAGE)
             print(INPUT_EXAMPLE)
@@ -343,15 +348,20 @@ def test_tone(tone, repeat):
     print("Duration: {duration} s".format(duration=duration))
 
 
-def print_date_time(h_shift):
+def print_date_time(h_shift, date_system):
     """
     Print date and time.
 
     :param h_shift: horizontal shift
     :type h_shift: int
+    :param date_system: date system
+    :type date_system: str
     :return: None
     """
-    datetime_now = datetime.datetime.now()
+    datetime_lib = datetime
+    if date_system == "jalali":
+        datetime_lib = jdatetime
+    datetime_now = datetime_lib.datetime.now()
     current_time = datetime_now.strftime(CLOCK_FORMAT)
     current_date = datetime_now.strftime(DATE_FORMAT)
     print(" " * h_shift, end='')
@@ -377,7 +387,8 @@ def countup_timer(
         sign=DEFAULT_PARAMS["sign"],
         hide_second=DEFAULT_PARAMS["hide_second"],
         hide_datetime=DEFAULT_PARAMS["hide_datetime"],
-        vertical=DEFAULT_PARAMS["vertical"]):
+        vertical=DEFAULT_PARAMS["vertical"],
+        date_system=DEFAULT_PARAMS["date_system"]):
     """
     Count-up timer function.
 
@@ -409,6 +420,8 @@ def countup_timer(
     :type hide_datetime: bool
     :param vertical: vertical mode flag
     :type vertical: bool
+    :param date_system: date system
+    :type date_system: str
     :return: None
     """
     timer_second = 0
@@ -423,12 +436,12 @@ def countup_timer(
         clear_screen()
         print('\n' * v_shift, end='')
         print(" " * h_shift, end='')
-        timer_params = [sign, timer_hour, timer_minute, timer_second]
+        timer_params = {"sign": sign, "hour": timer_hour, "minute": timer_minute, "second": timer_second}
         if hide_second:
-            timer_params = timer_params[:-1]
-        tprint(timer_template.format(*timer_params), font=face, sep="\n" + " " * h_shift)
+            del timer_params["second"]
+        tprint(timer_template.format(**timer_params), font=face, sep="\n" + " " * h_shift)
         if not hide_datetime:
-            print_date_time(h_shift)
+            print_date_time(h_shift, date_system)
         print(message)
         if timer_hour == hour and timer_minute == minute and timer_second == second:
             print(" " * h_shift, end='')
@@ -462,7 +475,8 @@ def countdown_timer(
         sign=DEFAULT_PARAMS["sign"],
         hide_second=DEFAULT_PARAMS["hide_second"],
         hide_datetime=DEFAULT_PARAMS["hide_datetime"],
-        vertical=DEFAULT_PARAMS["vertical"]):
+        vertical=DEFAULT_PARAMS["vertical"],
+        date_system=DEFAULT_PARAMS["date_system"]):
     """
     Countdown timer function.
 
@@ -494,6 +508,8 @@ def countdown_timer(
     :type hide_datetime: bool
     :param vertical: vertical mode flag
     :type vertical: bool
+    :param date_system: date system
+    :type date_system: str
     :return: None
     """
     face = get_face(face)
@@ -505,12 +521,12 @@ def countdown_timer(
         clear_screen()
         print('\n' * v_shift, end='')
         print(" " * h_shift, end='')
-        timer_params = [sign, hour, minute, second]
+        timer_params = {"sign": sign, "hour": hour, "minute": minute, "second": second}
         if hide_second:
-            timer_params = timer_params[:-1]
-        tprint(timer_template.format(*timer_params), font=face, sep="\n" + " " * h_shift)
+            del timer_params["second"]
+        tprint(timer_template.format(**timer_params), font=face, sep="\n" + " " * h_shift)
         if not hide_datetime:
-            print_date_time(h_shift)
+            print_date_time(h_shift, date_system)
         print(message)
         second -= 1
         if second == -1:
@@ -546,15 +562,15 @@ def pomodoro_timer(timer_func, params, long_break_params, short_break_params):
     h_shift = params["h_shift"]
     for index in range(4):
         work_params = params.copy()
-        work_params["message"] += " {0}/{1}".format(index + 1, 4)
+        work_params["message"] += " {round}/{repeat}".format(round=index + 1, repeat=4)
         timer_func(**work_params)
         if index == 3:
             break
-        print_message(message=NEXT_PROGRAM_MESSAGE.format("Short break"), h_shift=h_shift, confirm=True)
+        print_message(message=NEXT_PROGRAM_MESSAGE.format(next_program="Short break"), h_shift=h_shift, confirm=True)
         timer_func(**short_break_params)
         print_message(message=NEXT_PROGRAM_MESSAGE.format(
-            "Work {0}/{1}".format(index + 2, 4)), h_shift=h_shift, confirm=True)
-    print_message(message=NEXT_PROGRAM_MESSAGE.format("Long break"), h_shift=h_shift, confirm=True)
+            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)
 
 
@@ -572,7 +588,7 @@ def two_step_timer(timer_func, params1, params2):
     """
     h_shift = params1["h_shift"]
     timer_func(**params1)
-    print_message(message=NEXT_PROGRAM_MESSAGE.format("Break"), h_shift=h_shift, confirm=True)
+    print_message(message=NEXT_PROGRAM_MESSAGE.format(next_program="Break"), h_shift=h_shift, confirm=True)
     timer_func(**params2)
 
 
@@ -602,7 +618,7 @@ def update_set_on_params(params):
     :return: timer params as dict
     """
     if params["message"] == "":
-        params["message"] = SET_ON_MESSAGE.format(params["hour"], params["minute"], params["second"])
+        params["message"] = SET_ON_MESSAGE.format(hour=params["hour"], minute=params["minute"], second=params["second"])
     time_now = datetime.datetime.now()
     time_then = datetime.datetime(
         time_now.year,
@@ -680,9 +696,10 @@ def run_timer(args):
                 two_step_timer(timer_func, params1=params, params2=break_params)
             else:
                 timer_func(**params)
-            end_round_message = END_ROUND_MESSAGE.format("{0}/{1}".format(timer_round, args.repeat))
+            end_round_message = END_ROUND_MESSAGE.format(
+                round="{round}/{repeat}".format(round=timer_round, repeat=args.repeat))
             if args.repeat == -1:
-                end_round_message = END_ROUND_MESSAGE.format(timer_round)
+                end_round_message = END_ROUND_MESSAGE.format(round=timer_round)
             if timer_round < args.repeat or args.repeat == -1:
                 print_message(
                     message=end_round_message,

{mytimer-2.1 → mytimer-2.2}/mytimer/params.py

@@ -1,24 +1,24 @@
 # -*- coding: utf-8 -*-
 """mytimer params."""
 
-MY_TIMER_VERSION = "2.1"
+MY_TIMER_VERSION = "2.2"
 ADDITIONAL_INFO = "Additional information: Press `Ctrl+C` to exit."
 INPUT_ERROR_MESSAGE = "[Error] Wrong input"
 SOUND_ERROR_MESSAGE = "[Error] Unable to play sound"
 EXIT_MESSAGE = "See you. Bye!"
-END_ROUND_MESSAGE = "Round {0} done! Press `Enter` to continue..."
-NEXT_PROGRAM_MESSAGE = "Press `Enter` to continue (Next: {0})"
-PROGRAMS_LIST_TEMPLATE = "{0}. `{1}` - {2}"
-TIME_HMS_TEMPLATE_HORIZONTAL = "{0}{1:02} : {2:02} : {3:02}"
-TIME_HM_TEMPLATE_HORIZONTAL = "{0}{1:02} : {2:02}"
-TIME_HMS_TEMPLATE_VERTICAL = "{0}\n{1:02}\n{2:02}\n{3:02}"
-TIME_HM_TEMPLATE_VERTICAL = "{0}\n{1:02}\n{2:02}"
+END_ROUND_MESSAGE = "Round {round} done! Press `Enter` to continue..."
+NEXT_PROGRAM_MESSAGE = "Press `Enter` to continue (Next: {next_program})"
+PROGRAMS_LIST_TEMPLATE = "{index}. `{program}` - {message}"
+TIME_HMS_TEMPLATE_HORIZONTAL = "{sign}{hour:02} : {minute:02} : {second:02}"
+TIME_HM_TEMPLATE_HORIZONTAL = "{sign}{hour:02} : {minute:02}"
+TIME_HMS_TEMPLATE_VERTICAL = "{sign}\n{hour:02}\n{minute:02}\n{second:02}"
+TIME_HM_TEMPLATE_VERTICAL = "{sign}\n{hour:02}\n{minute:02}"
 FACES_LIST_EXAMPLE_MESSAGE = "12 : 34 : 56"
 INPUT_EXAMPLE = "Example: mytimer --hour=1 --minute=1 --second=1"
 TIME_ELEMENTS = ["minute", "second", "hour"]
-MESSAGE_TEMPLATE = "Message: {0}"
+MESSAGE_TEMPLATE = "Message: {message}"
 KEEP_ON_MESSAGE = " **Timeout!"
-SET_ON_MESSAGE = "Timer set for {0:02d}:{1:02d}:{2:02d}"
+SET_ON_MESSAGE = "Timer set for {hour:02d}:{minute:02d}:{second:02d}"
 DATE_FORMAT = "%A, %B %d, %Y"
 CLOCK_FORMAT = "%H:%M %p"
 KEEP_ON_MAX = 10000000
@@ -106,6 +106,7 @@ DEFAULT_PARAMS = {
     "alarm": 0,
     "hide_second": 0,
     "hide_datetime": 0,
+    "date_system": "gregorian",
     "vertical": 0,
     "alarm_repeat": 1,
     "face": 1,
@@ -344,3 +345,5 @@ BREAKS_MAP = {
 FACES_LIST = [-1] + sorted(FACES_MAP)
 
 TONES_LIST = [-1] + sorted(TONES_MAP)
+
+DATE_SYSTEMS_LIST = ["gregorian", "jalali"]

{mytimer-2.1 → mytimer-2.2}/mytimer.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.2
 Name: mytimer
-Version: 2.1
+Version: 2.2
 Summary: A Geeky Timer for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/mytimer
-Download-URL: https://github.com/sepandhaghighi/mytimer/tarball/v2.1
+Download-URL: https://github.com/sepandhaghighi/mytimer/tarball/v2.2
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -32,6 +32,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS.md
 Requires-Dist: art>=5.3
+Requires-Dist: jdatetime>=3.8.2
 Requires-Dist: nava>=0.4
 Dynamic: author
 Dynamic: author-email
@@ -105,13 +106,13 @@ The main objective of <strong>MyTimer</strong> is to offer a minimalistic and di
 ## Installation		
 
 ### Source Code
-- Download [Version 2.1](https://github.com/sepandhaghighi/mytimer/archive/v2.1.zip) or [Latest Source](https://github.com/sepandhaghighi/mytimer/archive/dev.zip)
+- 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.1`						
+- `pip install mytimer==2.2`						
 
 
 ## Usage
@@ -247,6 +248,16 @@ In this mode, the date/time will not be shown
 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
@@ -364,6 +375,15 @@ 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.2] - 2025-03-13
+### Added
+- `--date-system` argument
+### Changed
+- `README.md` updated
+- Test system modified
+- `countdown_timer` and `countup_timer` functions updated
+- String templates modified
+- Input case sensitivity bug fixed
 ## [2.1] - 2025-02-28
 ### Added
 - 4 new tones
@@ -568,7 +588,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.1...dev
+[Unreleased]: https://github.com/sepandhaghighi/mytimer/compare/v2.2...dev
+[2.2]: https://github.com/sepandhaghighi/mytimer/compare/v2.1...v2.2
 [2.1]: https://github.com/sepandhaghighi/mytimer/compare/v2.0...v2.1
 [2.0]: https://github.com/sepandhaghighi/mytimer/compare/v1.9...v2.0
 [1.9]: https://github.com/sepandhaghighi/mytimer/compare/v1.8...v1.9

{mytimer-2.1 → mytimer-2.2}/mytimer.egg-info/requires.txt

@@ -1,2 +1,3 @@
 art>=5.3
+jdatetime>=3.8.2
 nava>=0.4

{mytimer-2.1 → mytimer-2.2}/requirements.txt

@@ -1,2 +1,3 @@
 art>=5.3
+jdatetime>=3.8.2
 nava>=0.4

{mytimer-2.1 → mytimer-2.2}/setup.py

@@ -29,7 +29,7 @@ def read_description():
 setup(
     name='mytimer',
     packages=['mytimer'],
-    version='2.1',
+    version='2.2',
     description='A Geeky Timer for Terminal Enthusiasts',
     long_description=read_description(),
     long_description_content_type='text/markdown',
@@ -37,7 +37,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.1',
+    download_url='https://github.com/sepandhaghighi/mytimer/tarball/v2.2',
     keywords="timer time clock terminal stopwatch cli geek",
     project_urls={
         'Source': 'https://github.com/sepandhaghighi/mytimer'