clox 0.4__tar.gz → 0.6__tar.gz

{clox-0.4 → clox-0.6}/CHANGELOG.md

@@ -5,6 +5,18 @@ 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.6] - 2025-02-25
+### Added
+- `--calendar` argument
+### Changed
+- `README.md` updated
+## [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
@@ -31,7 +43,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.4...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.6...dev
+[0.6]: https://github.com/sepandhaghighi/clox/compare/v0.5...v0.6
+[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

{clox-0.4 → clox-0.6}/PKG-INFO

@@ -1,15 +1,15 @@
 Metadata-Version: 2.2
 Name: clox
-Version: 0.4
+Version: 0.6
 Summary: A Geeky Clock for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/clox
-Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.4
+Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.6
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
 Project-URL: Source, https://github.com/sepandhaghighi/clox
 Keywords: clock time timer timezone terminal cli geek clox
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Natural Language :: English
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -103,13 +103,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 0.4](https://github.com/sepandhaghighi/clox/archive/v0.4.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 0.6](https://github.com/sepandhaghighi/clox/archive/v0.6.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.4`						
+- `pip install clox==0.6`						
 
 
 ## Usage
@@ -169,12 +169,54 @@ 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
 ```
 
+### Calendar Mode
+
+In this mode, the calendar will be displayed
+
+ℹ️ Valid choices: [`month`, `year`]
+
+```console
+clox --calendar=month
+```
+
+## 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!
@@ -225,6 +267,18 @@ 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.6] - 2025-02-25
+### Added
+- `--calendar` argument
+### Changed
+- `README.md` updated
+## [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
@@ -251,7 +305,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.4...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.6...dev
+[0.6]: https://github.com/sepandhaghighi/clox/compare/v0.5...v0.6
+[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

{clox-0.4 → clox-0.6}/README.md

@@ -53,13 +53,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 0.4](https://github.com/sepandhaghighi/clox/archive/v0.4.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 0.6](https://github.com/sepandhaghighi/clox/archive/v0.6.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.4`						
+- `pip install clox==0.6`						
 
 
 ## Usage
@@ -119,12 +119,54 @@ 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
 ```
 
+### Calendar Mode
+
+In this mode, the calendar will be displayed
+
+ℹ️ Valid choices: [`month`, `year`]
+
+```console
+clox --calendar=month
+```
+
+## 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.4 → clox-0.6}/SECURITY.md

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

{clox-0.4 → clox-0.6}/clox/functions.py

@@ -3,15 +3,17 @@
 import os
 import sys
 import time
+import calendar
 import random
 import datetime
 import argparse
 import pytz
 from art import tprint
-from .params import HORIZONTAL_TIME_FORMATS, VERTICAL_TIME_FORMATS, DATE_FORMAT
-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 FACES_MAP, FACES_LIST, CALENDAR_LIST
 from .params import HORIZONTAL_FACES_LIST_EXAMPLE, VERTICAL_FACES_LIST_EXAMPLE
 from .params import CLOX_OVERVIEW, CLOX_REPO
 
@@ -66,9 +68,9 @@ def show_faces_list(vertical=False):
     if vertical:
         example = VERTICAL_FACES_LIST_EXAMPLE
         mode = "Vertical"
-    print("Faces list ({0}):\n".format(mode))
+    print("Faces list ({mode}):\n".format(mode=mode))
     for i in sorted(FACES_MAP):
-        print('Face {}\n'.format(i))
+        print('Face {index}\n'.format(index=i))
         tprint(example, font=get_face(i))
         print('=' * 80)
 
@@ -81,10 +83,53 @@ def show_timezones_list():
     """
     print("Timezones list:\n")
     for index, timezone in enumerate(TIMEZONES_LIST, 1):
-        print("{0}. {1}".format(index, timezone))
+        print("{index}. {timezone}".format(index=index, timezone=timezone))
 
 
-def run_clock(timezone=None, v_shift=0, h_shift=0, face=1, no_blink=False, vertical=False):
+def print_calendar(mode="month", timezone=None, v_shift=0, h_shift=0):
+    """
+    Print calendar.
+
+    :param mode: calendar mode
+    :type mode: str
+    :param timezone: timezone
+    :type timezone: str
+    :param v_shift: vertical shift
+    :type v_shift: int
+    :param h_shift: horizontal shift
+    :type h_shift: int
+    :return: None
+    """
+    tz = None
+    timezone_str = "Local"
+    if timezone is not None:
+        timezone_str = timezone
+        tz = pytz.timezone(timezone)
+    v_shift = max(0, v_shift)
+    h_shift = max(0, h_shift)
+    datetime_now = datetime.datetime.now(tz=tz)
+    current_date = datetime_now.strftime(DATE_FORMAT)
+    print('\n' * v_shift, end='')
+    print(" " * h_shift, end='')
+    print("Today: {date}".format(date=current_date))
+    print(" " * h_shift, end='')
+    print("Timezone: {timezone}\n".format(timezone=timezone_str))
+    calendar_str = calendar.month(datetime_now.year, datetime_now.month)
+    if mode == "year":
+        calendar_str = calendar.calendar(datetime_now.year)
+    print("\n".join([" " * h_shift + x for x in calendar_str.split("\n")]))
+
+
+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.
 
@@ -100,17 +145,22 @@ 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
-    if timezone is None:
-        tz = None
-        timezone_str = "Local"
-    else:
+        time_formats = VERTICAL_TIME_12H_FORMATS if am_pm else VERTICAL_TIME_24H_FORMATS
+    tz = None
+    timezone_str = "Local"
+    if timezone is not None:
+        timezone_str = timezone
         tz = pytz.timezone(timezone)
     v_shift = max(0, v_shift)
     h_shift = max(0, h_shift)
@@ -123,10 +173,12 @@ def run_clock(timezone=None, v_shift=0, h_shift=0, face=1, no_blink=False, verti
         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(current_date)
-        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: {timezone}".format(timezone=timezone_str))
         time.sleep(1)
         if not no_blink:
             format_index = int(not format_index)
@@ -150,6 +202,10 @@ def main():
     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)
+    parser.add_argument('--calendar', help='calendar mode', type=str, choices=CALENDAR_LIST)
     args = parser.parse_args()
     if args.version:
         print(CLOX_VERSION)
@@ -159,6 +215,8 @@ def main():
         show_faces_list(vertical=args.vertical)
     elif args.timezones_list:
         show_timezones_list()
+    elif args.calendar:
+        print_calendar(mode=args.calendar, timezone=args.timezone, h_shift=args.h_shift, v_shift=args.v_shift)
     else:
         try:
             run_clock(
@@ -167,6 +225,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.4 → clox-0.6}/clox/params.py

@@ -2,7 +2,7 @@
 """clox params."""
 import pytz
 
-CLOX_VERSION = "0.4"
+CLOX_VERSION = "0.6"
 
 CLOX_OVERVIEW = '''
 Clox is a terminal-based clock application designed for terminal enthusiasts who appreciate simplicity,
@@ -18,8 +18,10 @@ 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
@@ -54,3 +56,5 @@ FACES_MAP = {
 }
 
 FACES_LIST = [-1] + sorted(FACES_MAP)
+
+CALENDAR_LIST = ["month", "year"]

{clox-0.4 → clox-0.6}/clox.egg-info/PKG-INFO

@@ -1,15 +1,15 @@
 Metadata-Version: 2.2
 Name: clox
-Version: 0.4
+Version: 0.6
 Summary: A Geeky Clock for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/clox
-Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.4
+Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.6
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
 Project-URL: Source, https://github.com/sepandhaghighi/clox
 Keywords: clock time timer timezone terminal cli geek clox
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Natural Language :: English
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -103,13 +103,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 0.4](https://github.com/sepandhaghighi/clox/archive/v0.4.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 0.6](https://github.com/sepandhaghighi/clox/archive/v0.6.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.4`						
+- `pip install clox==0.6`						
 
 
 ## Usage
@@ -169,12 +169,54 @@ 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
 ```
 
+### Calendar Mode
+
+In this mode, the calendar will be displayed
+
+ℹ️ Valid choices: [`month`, `year`]
+
+```console
+clox --calendar=month
+```
+
+## 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!
@@ -225,6 +267,18 @@ 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.6] - 2025-02-25
+### Added
+- `--calendar` argument
+### Changed
+- `README.md` updated
+## [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
@@ -251,7 +305,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.4...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.6...dev
+[0.6]: https://github.com/sepandhaghighi/clox/compare/v0.5...v0.6
+[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

{clox-0.4 → clox-0.6}/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.4 → clox-0.6}/setup.py

@@ -29,7 +29,7 @@ def read_description():
 setup(
     name='clox',
     packages=['clox'],
-    version='0.4',
+    version='0.6',
     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.4',
+    download_url='https://github.com/sepandhaghighi/clox/tarball/v0.6',
     keywords="clock time timer timezone terminal cli geek clox",
     project_urls={
         'Source': 'https://github.com/sepandhaghighi/clox'
@@ -45,7 +45,7 @@ setup(
     install_requires=get_requires(),
     python_requires='>=3.6',
     classifiers=[
-        'Development Status :: 3 - Alpha',
+        'Development Status :: 4 - Beta',
         'Natural Language :: English',
         'License :: OSI Approved :: MIT License',
         'Operating System :: OS Independent',