clox 0.3__tar.gz → 0.5__tar.gz

{clox-0.3 → clox-0.5}/CHANGELOG.md

@@ -5,6 +5,17 @@ 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]
+## [0.5] - 2025-02-14
+### Added
+- `--hide-date` argument
+- `--hide-timezone` argument
+- `--am-pm` argument
+### Changed
+- `README.md` updated
+## [0.4] - 2025-01-18
+### Added
+- Date
+- `--info` argument
 ## [0.3] - 2025-01-10
 ### Added
 - Logo
@@ -27,7 +38,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `TIMEZONES.md`
 - `FACES.md`
 
-[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.3...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.5...dev
+[0.5]: https://github.com/sepandhaghighi/clox/compare/v0.4...v0.5
+[0.4]: https://github.com/sepandhaghighi/clox/compare/v0.3...v0.4
 [0.3]: https://github.com/sepandhaghighi/clox/compare/v0.2...v0.3
 [0.2]: https://github.com/sepandhaghighi/clox/compare/v0.1...v0.2
 [0.1]: https://github.com/sepandhaghighi/clox/compare/e9b49e2...v0.1

{clox-0.3 → clox-0.5}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.2
 Name: clox
-Version: 0.3
+Version: 0.5
 Summary: A Geeky Clock for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/clox
-Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.3
+Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.5
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -103,13 +103,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 0.3](https://github.com/sepandhaghighi/clox/archive/v0.3.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 0.5](https://github.com/sepandhaghighi/clox/archive/v0.5.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install clox==0.3`						
+- `pip install clox==0.5`						
 
 
 ## Usage
@@ -122,6 +122,12 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 clox --version
 ```
 
+### Info
+
+```console
+clox --info
+```
+
 ### Basic
 
 ℹ️ Press `Ctrl + C` to exit
@@ -163,12 +169,44 @@ Disable blinking mode
 clox --no-blink
 ```
 
+### Hide Date
+
+In this mode, the date will not be shown
+
+```console
+clox --hide-date
+```
+
+### Hide Timezone
+
+In this mode, the timezone will not be shown
+
+```console
+clox --hide-timezone
+```
+
+### AM/PM Mode
+
+In this mode, the clock will be displayed in 12-hour format
+
+```console
+clox --am-pm
+```
+
 ### Vertical Mode
 
 ```console
 clox --vertical
 ```
 
+## Screen Record
+
+<div align="center">
+
+<img src="https://github.com/sepandhaghighi/clox/raw/main/otherfiles/help.gif">
+
+</div>
+
 ## Issues & Bug Reports			
 
 Just fill an issue and describe it. We'll check it ASAP!
@@ -219,6 +257,17 @@ 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]
+## [0.5] - 2025-02-14
+### Added
+- `--hide-date` argument
+- `--hide-timezone` argument
+- `--am-pm` argument
+### Changed
+- `README.md` updated
+## [0.4] - 2025-01-18
+### Added
+- Date
+- `--info` argument
 ## [0.3] - 2025-01-10
 ### Added
 - Logo
@@ -241,7 +290,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `TIMEZONES.md`
 - `FACES.md`
 
-[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.3...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.5...dev
+[0.5]: https://github.com/sepandhaghighi/clox/compare/v0.4...v0.5
+[0.4]: https://github.com/sepandhaghighi/clox/compare/v0.3...v0.4
 [0.3]: https://github.com/sepandhaghighi/clox/compare/v0.2...v0.3
 [0.2]: https://github.com/sepandhaghighi/clox/compare/v0.1...v0.2
 [0.1]: https://github.com/sepandhaghighi/clox/compare/e9b49e2...v0.1

{clox-0.3 → clox-0.5}/README.md

@@ -53,13 +53,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 0.3](https://github.com/sepandhaghighi/clox/archive/v0.3.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 0.5](https://github.com/sepandhaghighi/clox/archive/v0.5.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install clox==0.3`						
+- `pip install clox==0.5`						
 
 
 ## Usage
@@ -72,6 +72,12 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 clox --version
 ```
 
+### Info
+
+```console
+clox --info
+```
+
 ### Basic
 
 ℹ️ Press `Ctrl + C` to exit
@@ -113,12 +119,44 @@ Disable blinking mode
 clox --no-blink
 ```
 
+### Hide Date
+
+In this mode, the date will not be shown
+
+```console
+clox --hide-date
+```
+
+### Hide Timezone
+
+In this mode, the timezone will not be shown
+
+```console
+clox --hide-timezone
+```
+
+### AM/PM Mode
+
+In this mode, the clock will be displayed in 12-hour format
+
+```console
+clox --am-pm
+```
+
 ### Vertical Mode
 
 ```console
 clox --vertical
 ```
 
+## Screen Record
+
+<div align="center">
+
+<img src="https://github.com/sepandhaghighi/clox/raw/main/otherfiles/help.gif">
+
+</div>
+
 ## Issues & Bug Reports			
 
 Just fill an issue and describe it. We'll check it ASAP!

{clox-0.3 → clox-0.5}/SECURITY.md

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

{clox-0.3 → clox-0.5}/clox/functions.py

@@ -8,11 +8,25 @@ import datetime
 import argparse
 import pytz
 from art import tprint
-from .params import HORIZONTAL_TIME_FORMATS, VERTICAL_TIME_FORMATS
-from .params import TIMEZONES_LIST, CLOX_VERSION
+from .params import HORIZONTAL_TIME_24H_FORMATS, VERTICAL_TIME_24H_FORMATS
+from .params import HORIZONTAL_TIME_12H_FORMATS, VERTICAL_TIME_12H_FORMATS
+from .params import TIMEZONES_LIST, CLOX_VERSION, DATE_FORMAT
 from .params import ADDITIONAL_INFO, EXIT_MESSAGE
 from .params import FACES_MAP, FACES_LIST
 from .params import HORIZONTAL_FACES_LIST_EXAMPLE, VERTICAL_FACES_LIST_EXAMPLE
+from .params import CLOX_OVERVIEW, CLOX_REPO
+
+
+def clox_info():
+    """
+    Print clox details.
+
+    :return: None
+    """
+    tprint("Clox")
+    tprint("V:" + CLOX_VERSION)
+    print(CLOX_OVERVIEW)
+    print(CLOX_REPO)
 
 
 def clear_screen():
@@ -71,7 +85,16 @@ def show_timezones_list():
         print("{0}. {1}".format(index, timezone))
 
 
-def run_clock(timezone=None, v_shift=0, h_shift=0, face=1, no_blink=False, vertical=False):
+def run_clock(
+        timezone=None,
+        v_shift=0,
+        h_shift=0,
+        face=1,
+        no_blink=False,
+        vertical=False,
+        hide_date=False,
+        hide_timezone=False,
+        am_pm=False):
     """
     Run clock.
 
@@ -87,13 +110,19 @@ def run_clock(timezone=None, v_shift=0, h_shift=0, face=1, no_blink=False, verti
     :type no_blink: bool
     :param vertical: vertical mode flag
     :type vertical: bool
+    :param hide_date: hide date flag
+    :type hide_date: bool
+    :param hide_timezone: hide timezone flag
+    :type hide_timezone: bool
+    :param am_pm: AM/PM mode flag
+    :type am_pm: bool
     :return: None
     """
     format_index = 0
     timezone_str = timezone
-    time_formats = HORIZONTAL_TIME_FORMATS
+    time_formats = HORIZONTAL_TIME_12H_FORMATS if am_pm else HORIZONTAL_TIME_24H_FORMATS
     if vertical:
-        time_formats = VERTICAL_TIME_FORMATS
+        time_formats = VERTICAL_TIME_12H_FORMATS if am_pm else VERTICAL_TIME_24H_FORMATS
     if timezone is None:
         tz = None
         timezone_str = "Local"
@@ -106,10 +135,16 @@ def run_clock(timezone=None, v_shift=0, h_shift=0, face=1, no_blink=False, verti
         clear_screen()
         print('\n' * v_shift, end='')
         print(" " * h_shift, end='')
-        current_time = datetime.datetime.now(tz=tz).strftime(time_formats[format_index])
+        datetime_now = datetime.datetime.now(tz=tz)
+        current_time = datetime_now.strftime(time_formats[format_index])
+        current_date = datetime_now.strftime(DATE_FORMAT)
         tprint(current_time, font=face, sep="\n" + " " * h_shift)
-        print(" " * h_shift, end='')
-        print("Timezone: {0}".format(timezone_str))
+        if not hide_date:
+            print(" " * h_shift, end='')
+            print(current_date)
+        if not hide_timezone:
+            print(" " * h_shift, end='')
+            print("Timezone: {0}".format(timezone_str))
         time.sleep(1)
         if not no_blink:
             format_index = int(not format_index)
@@ -127,14 +162,20 @@ def main():
     parser.add_argument('--v-shift', help='vertical shift', type=int, default=0)
     parser.add_argument('--h-shift', help='horizontal shift', type=int, default=0)
     parser.add_argument('--version', help='version', nargs="?", const=1)
+    parser.add_argument('--info', help='info', nargs="?", const=1)
     parser.add_argument('--face', help='face', type=int, choices=FACES_LIST, default=1)
     parser.add_argument('--faces-list', help='faces list', nargs="?", const=1)
     parser.add_argument('--timezones-list', help='timezones list', nargs="?", const=1)
     parser.add_argument('--no-blink', help='disable blinking mode', nargs="?", const=1)
     parser.add_argument('--vertical', help='vertical mode', nargs="?", const=1)
+    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)
     args = parser.parse_args()
     if args.version:
         print(CLOX_VERSION)
+    elif args.info:
+        clox_info()
     elif args.faces_list:
         show_faces_list(vertical=args.vertical)
     elif args.timezones_list:
@@ -147,6 +188,9 @@ def main():
                 v_shift=args.v_shift,
                 face=args.face,
                 no_blink=args.no_blink,
-                vertical=args.vertical)
+                vertical=args.vertical,
+                hide_date=args.hide_date,
+                hide_timezone=args.hide_timezone,
+                am_pm=args.am_pm)
         except (KeyboardInterrupt, EOFError):
             print(EXIT_MESSAGE)

{clox-0.3 → clox-0.5}/clox/params.py

@@ -2,7 +2,15 @@
 """clox params."""
 import pytz
 
-CLOX_VERSION = "0.3"
+CLOX_VERSION = "0.5"
+
+CLOX_OVERVIEW = '''
+Clox is a terminal-based clock application designed for terminal enthusiasts who appreciate simplicity,
+elegance, and productivity within their command-line environment. Whether you're coding, monitoring tasks,
+or simply enjoying the terminal aesthetic, Clox brings a stylish and customizable time display to your workspace.
+'''
+
+CLOX_REPO = "Repo : https://github.com/sepandhaghighi/clox"
 
 ADDITIONAL_INFO = "Additional information: Press `Ctrl+C` to exit."
 EXIT_MESSAGE = "See you. Bye!"
@@ -10,8 +18,11 @@ EXIT_MESSAGE = "See you. Bye!"
 HORIZONTAL_FACES_LIST_EXAMPLE = "12:34"
 VERTICAL_FACES_LIST_EXAMPLE = "12\n34"
 
-HORIZONTAL_TIME_FORMATS = ['%H:%M', '%H:%M.']
-VERTICAL_TIME_FORMATS = ['%H\n%M', '%H\n%M.']
+HORIZONTAL_TIME_24H_FORMATS = ['%H:%M', '%H:%M.']
+VERTICAL_TIME_24H_FORMATS = ['%H\n%M', '%H\n%M.']
+HORIZONTAL_TIME_12H_FORMATS = ['%I:%M %p', '%I:%M %p.']
+VERTICAL_TIME_12H_FORMATS = ['%I\n%M\n%p', '%I\n%M\n%p.']
+DATE_FORMAT = "%A, %B %d, %Y"
 
 TIMEZONES_LIST = pytz.all_timezones
 

{clox-0.3 → clox-0.5}/clox.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.2
 Name: clox
-Version: 0.3
+Version: 0.5
 Summary: A Geeky Clock for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/clox
-Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.3
+Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.5
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -103,13 +103,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 0.3](https://github.com/sepandhaghighi/clox/archive/v0.3.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 0.5](https://github.com/sepandhaghighi/clox/archive/v0.5.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
 - `pip install .`				
 
 ### PyPI
 
 - Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
-- `pip install clox==0.3`						
+- `pip install clox==0.5`						
 
 
 ## Usage
@@ -122,6 +122,12 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 clox --version
 ```
 
+### Info
+
+```console
+clox --info
+```
+
 ### Basic
 
 ℹ️ Press `Ctrl + C` to exit
@@ -163,12 +169,44 @@ Disable blinking mode
 clox --no-blink
 ```
 
+### Hide Date
+
+In this mode, the date will not be shown
+
+```console
+clox --hide-date
+```
+
+### Hide Timezone
+
+In this mode, the timezone will not be shown
+
+```console
+clox --hide-timezone
+```
+
+### AM/PM Mode
+
+In this mode, the clock will be displayed in 12-hour format
+
+```console
+clox --am-pm
+```
+
 ### Vertical Mode
 
 ```console
 clox --vertical
 ```
 
+## Screen Record
+
+<div align="center">
+
+<img src="https://github.com/sepandhaghighi/clox/raw/main/otherfiles/help.gif">
+
+</div>
+
 ## Issues & Bug Reports			
 
 Just fill an issue and describe it. We'll check it ASAP!
@@ -219,6 +257,17 @@ 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]
+## [0.5] - 2025-02-14
+### Added
+- `--hide-date` argument
+- `--hide-timezone` argument
+- `--am-pm` argument
+### Changed
+- `README.md` updated
+## [0.4] - 2025-01-18
+### Added
+- Date
+- `--info` argument
 ## [0.3] - 2025-01-10
 ### Added
 - Logo
@@ -241,7 +290,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `TIMEZONES.md`
 - `FACES.md`
 
-[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.3...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.5...dev
+[0.5]: https://github.com/sepandhaghighi/clox/compare/v0.4...v0.5
+[0.4]: https://github.com/sepandhaghighi/clox/compare/v0.3...v0.4
 [0.3]: https://github.com/sepandhaghighi/clox/compare/v0.2...v0.3
 [0.2]: https://github.com/sepandhaghighi/clox/compare/v0.1...v0.2
 [0.1]: https://github.com/sepandhaghighi/clox/compare/e9b49e2...v0.1

{clox-0.3 → clox-0.5}/dev-requirements.txt

@@ -1,4 +1,4 @@
-pytz==2024.2
+pytz==2025.1
 art==6.4
 setuptools>=40.8.0
 vulture>=1.0

{clox-0.3 → clox-0.5}/setup.py

@@ -29,7 +29,7 @@ def read_description():
 setup(
     name='clox',
     packages=['clox'],
-    version='0.3',
+    version='0.5',
     description='A Geeky Clock 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/clox',
-    download_url='https://github.com/sepandhaghighi/clox/tarball/v0.3',
+    download_url='https://github.com/sepandhaghighi/clox/tarball/v0.5',
     keywords="clock time timer timezone terminal cli geek clox",
     project_urls={
         'Source': 'https://github.com/sepandhaghighi/clox'