Once (#87)

* feat : --once argument added

* doc : README.md updated

* doc : CHANGELOG.md updated

* fix : test.yml updated

* fix : autopep8

* fix : notebook.ipynb updated

* doc : CHANGELOG.md updated

Author: sepandhaghighi

.github/workflows/test.yml

@@ -89,6 +89,9 @@ jobs:
     - name: Run17
       run: |
         clox --date-system=jalali --date-formats-list --color="red" --bg-color="blue" --intensity="bright"
+    - name: Run18
+      run: |
+        clox --date-system=jalali --once
     - name: Install dev-requirements
       run: |
         python otherfiles/requirements-splitter.py

CHANGELOG.md

@@ -7,10 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 ### Added
 - `--intensity` argument
+- `--once` argument
 - Light colors
 ### Changed
 - `README.md` updated
 - Test system modified
+- `notebook.ipynb` updated
 ## [1.4] - 2025-12-16
 ### Added
 - `--color` argument

README.md

@@ -142,6 +142,14 @@ Disable blinking mode
 clox --no-blink
 ```
 
+### Once
+
+Print current time once and exit immediately
+
+```console
+clox --once
+```
+
 ### Hide Date
 
 In this mode, the date will not be shown

clox/functions.py

@@ -301,7 +301,8 @@ def run_clock(
         date_system: str = "GREGORIAN",
         date_format: str = "FULL",
         offset_local: float = 0,
-        offset_timezone: float = 0) -> None:
+        offset_timezone: float = 0,
+        once: bool = False) -> None:
     """
     Run clock.
 
@@ -319,6 +320,7 @@ def run_clock(
     :param date_format: date format
     :param offset_local: manual offset for the local time
     :param offset_timezone: manual offset for the timezone
+    :param once: once flag
     """
     try:
         detected_environment = detect_environment()
@@ -349,7 +351,8 @@ def run_clock(
         h_shift = max(0, h_shift)
         face = get_face(face)
         while True:
-            clear_screen(detected_environment)
+            if not once:
+                clear_screen(detected_environment)
             print('\n' * v_shift, end='')
             print(" " * h_shift, end='')
             datetime_timezone = datetime_lib.datetime.now(tz=tz) + offset_main_timedelta
@@ -373,6 +376,8 @@ def run_clock(
                 if offset_local != 0:
                     print(" " * h_shift, end='')
                     print(OFFSET_FORMAT.format(offset_type="Local", offset_value=offset_local))
+            if once:
+                break
             time.sleep(1)
             if not no_blink:
                 format_index = int(not format_index)
@@ -400,6 +405,7 @@ def main() -> None:
     parser.add_argument('--hide-date', help='hide date', nargs="?", const=1)
     parser.add_argument('--hide-timezone', help='hide timezone', nargs="?", const=1)
     parser.add_argument('--am-pm', help='AM/PM mode', nargs="?", const=1)
+    parser.add_argument('--once', help='print current time once and exit immediately', nargs='?', const=1)
     parser.add_argument('--calendar', help='calendar mode', type=str.upper, choices=CALENDARS_LIST)
     parser.add_argument('--first-weekday', help='first weekday', type=str.upper, default="MONDAY",
                         choices=WEEKDAYS_LIST + [x[:2] for x in WEEKDAYS_LIST])
@@ -458,4 +464,5 @@ def main() -> None:
             date_system=args.date_system,
             date_format=args.date_format,
             offset_local=args.offset_local,
-            offset_timezone=args.offset_timezone)
+            offset_timezone=args.offset_timezone,
+            once=args.once)

clox/params.py

@@ -97,6 +97,6 @@
     'LIGHTMAGENTA',
     'LIGHTCYAN',
     'LIGHTWHITE'
-    ]
+]
 
 INTENSITY_LIST = ['NORMAL', 'BRIGHT', 'DIM']

notebook.ipynb

@@ -72,7 +72,8 @@
     "    \"date_system\": \"GREGORIAN\", # [\"GREGORIAN\", \"JALALI\"]\n",
     "    \"date_format\": \"FULL\", # ['DASH', 'DMY', 'DOT', 'EU', 'EU-SHORT', 'FULL', 'ISO', 'MDY', 'US', 'US-SHORT', 'YMD']\n",
     "    \"offset_local\": 0,\n",
-    "    \"offset_timezone\": 0\n",
+    "    \"offset_timezone\": 0,\n",
+    "    \"once\": False\n",
     "}"
    ]
   },