clox 1.0__tar.gz → 1.1__tar.gz

{clox-1.0 → clox-1.1}/CHANGELOG.md

@@ -5,6 +5,14 @@ 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]
+## [1.1] - 2025-05-23
+### Added
+- `--first-weekday` argument
+- `--date-format` argument
+- `--date-formats-list` argument
+### Changed
+- `README.md` updated
+- Test system modified
 ## [1.0] - 2025-05-06
 ### Added
 - Local time
@@ -71,7 +79,8 @@ 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/v1.0...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v1.1...dev
+[1.1]: https://github.com/sepandhaghighi/clox/compare/v1.0...v1.1
 [1.0]: https://github.com/sepandhaghighi/clox/compare/v0.9...v1.0
 [0.9]: https://github.com/sepandhaghighi/clox/compare/v0.8...v0.9
 [0.8]: https://github.com/sepandhaghighi/clox/compare/v0.7...v0.8

{clox-1.0 → clox-1.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: clox
-Version: 1.0
+Version: 1.1
 Summary: A Geeky Clock for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/clox
-Download-URL: https://github.com/sepandhaghighi/clox/tarball/v1.0
+Download-URL: https://github.com/sepandhaghighi/clox/tarball/v1.1
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -104,13 +104,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 1.0](https://github.com/sepandhaghighi/clox/archive/v1.0.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 1.1](https://github.com/sepandhaghighi/clox/archive/v1.1.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==1.0`						
+- `pip install clox==1.1`						
 
 
 ## Usage
@@ -218,22 +218,33 @@ clox --vertical
 
 In this mode, the calendar will be displayed
 
-ℹ️ Valid choices: [`month`, `year`]
+ℹ️ Valid choices: [`MONTH`, `YEAR`]
 
 ```console
-clox --calendar=month
+clox --calendar=month --first-weekday="SUNDAY"
 ```
 
 ### Date System
 
-ℹ️ Valid choices: [`gregorian`, `jalali`]
+ℹ️ Valid choices: [`GREGORIAN`, `JALALI`]
 
-ℹ️ The default date system is `gregorian`
+ℹ️ The default date system is `GREGORIAN`
 
 ```console
 clox --date-system=jalali
 ```
 
+### Date Format
+
+ℹ️ Valid choices: [`ISO`, `US`, `US-SHORT`, `EU`, `EU-SHORT`, `DOT`, `DASH`, `YMD`, `DMY`, `MDY`, `FULL`]
+
+ℹ️ The default date format is `FULL`
+
+```console
+clox --date-system=jalali --date-format=EU
+```
+* Date Formats List: `clox --date-formats-list`
+
 ## Screen Record
 
 <div align="center">
@@ -292,6 +303,14 @@ 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]
+## [1.1] - 2025-05-23
+### Added
+- `--first-weekday` argument
+- `--date-format` argument
+- `--date-formats-list` argument
+### Changed
+- `README.md` updated
+- Test system modified
 ## [1.0] - 2025-05-06
 ### Added
 - Local time
@@ -358,7 +377,8 @@ 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/v1.0...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v1.1...dev
+[1.1]: https://github.com/sepandhaghighi/clox/compare/v1.0...v1.1
 [1.0]: https://github.com/sepandhaghighi/clox/compare/v0.9...v1.0
 [0.9]: https://github.com/sepandhaghighi/clox/compare/v0.8...v0.9
 [0.8]: https://github.com/sepandhaghighi/clox/compare/v0.7...v0.8

{clox-1.0 → clox-1.1}/README.md

@@ -53,13 +53,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 1.0](https://github.com/sepandhaghighi/clox/archive/v1.0.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 1.1](https://github.com/sepandhaghighi/clox/archive/v1.1.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==1.0`						
+- `pip install clox==1.1`						
 
 
 ## Usage
@@ -167,22 +167,33 @@ clox --vertical
 
 In this mode, the calendar will be displayed
 
-ℹ️ Valid choices: [`month`, `year`]
+ℹ️ Valid choices: [`MONTH`, `YEAR`]
 
 ```console
-clox --calendar=month
+clox --calendar=month --first-weekday="SUNDAY"
 ```
 
 ### Date System
 
-ℹ️ Valid choices: [`gregorian`, `jalali`]
+ℹ️ Valid choices: [`GREGORIAN`, `JALALI`]
 
-ℹ️ The default date system is `gregorian`
+ℹ️ The default date system is `GREGORIAN`
 
 ```console
 clox --date-system=jalali
 ```
 
+### Date Format
+
+ℹ️ Valid choices: [`ISO`, `US`, `US-SHORT`, `EU`, `EU-SHORT`, `DOT`, `DASH`, `YMD`, `DMY`, `MDY`, `FULL`]
+
+ℹ️ The default date format is `FULL`
+
+```console
+clox --date-system=jalali --date-format=EU
+```
+* Date Formats List: `clox --date-formats-list`
+
 ## Screen Record
 
 <div align="center">

{clox-1.0 → clox-1.1}/SECURITY.md

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

{clox-1.0 → clox-1.1}/clox/functions.py

@@ -15,12 +15,13 @@ from .jcalendar import TextCalendar as JalaliCalendar
 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 TIMEZONE_DIFFERENCE_FORMAT
-from .params import CLOX_VERSION, DATE_FORMAT
-from .params import TIMEZONES_LIST, COUNTRIES_LIST
+from .params import CLOX_VERSION
+from .params import TIMEZONES_LIST, COUNTRIES_LIST, WEEKDAYS_LIST
 from .params import ADDITIONAL_INFO, EXIT_MESSAGE
 from .params import FACES_MAP, FACES_LIST, CALENDARS_LIST, DATE_SYSTEMS_LIST
 from .params import HORIZONTAL_FACES_LIST_EXAMPLE, VERTICAL_FACES_LIST_EXAMPLE
 from .params import CLOX_OVERVIEW, CLOX_REPO
+from .params import DATE_FORMATS_MAP, DATE_FORMATS_LIST
 
 
 def clox_info() -> None:
@@ -125,13 +126,49 @@ def show_countries_list() -> None:
                                                                     country_code=country_code, country_name=country_code))
 
 
+def show_date_formats_list(date_system: str = "GREGORIAN") -> None:
+    """
+    Show date formats list.
+
+    :param date_system: date system
+    """
+    datetime_lib = datetime
+    example_year = 1990
+    if date_system == "JALALI":
+        datetime_lib = jdatetime
+        example_year = 1368
+    print("Date formats list:\n")
+    example_date = datetime_lib.datetime(year=example_year, month=7, day=23)
+    for index, date_format in enumerate(DATE_FORMATS_LIST, 1):
+        print("{index}. {date_format_code} - {date_format_example}".format(index=index,
+                                                                           date_format_code=date_format, date_format_example=example_date.strftime(DATE_FORMATS_MAP[date_format])))
+
+
+def _get_weekday_id(first_weekday: str, date_system: str = "GREGORIAN") -> int:
+    """
+    Get weekday id.
+
+    :param first_weekday: first weekday
+    :param date_system: date system
+    """
+    first_weekday_normalized = first_weekday.upper()
+    if len(first_weekday) > 2:
+        first_weekday_normalized = first_weekday_normalized[:2]
+    weekdays = [x[:2] for x in WEEKDAYS_LIST]
+    if date_system == "JALALI":
+        weekdays = weekdays[-2:] + weekdays[:-2]
+    return weekdays.index(first_weekday_normalized)
+
+
 def print_calendar(
-        mode: str = "month",
+        mode: str = "MONTH",
         timezone: Optional[str] = None,
         country: Optional[str] = None,
         v_shift: int = 0,
         h_shift: int = 0,
-        date_system: str = "gregorian") -> None:
+        date_system: str = "GREGORIAN",
+        date_format: str = "FULL",
+        first_weekday: str = "MONDAY") -> None:
     """
     Print calendar.
 
@@ -141,12 +178,15 @@ def print_calendar(
     :param v_shift: vertical shift
     :param h_shift: horizontal shift
     :param date_system: date system
+    :param date_format: date format
+    :param first_weekday: first weekday
     """
+    first_weekday_id = _get_weekday_id(first_weekday, date_system)
     datetime_lib = datetime
-    calendar_obj = GregorianCalendar()
-    if date_system == "jalali":
+    calendar_obj = GregorianCalendar(first_weekday_id)
+    if date_system == "JALALI":
         datetime_lib = jdatetime
-        calendar_obj = JalaliCalendar()
+        calendar_obj = JalaliCalendar(first_weekday_id)
     tz = None
     timezone_str = "Local"
     if country is not None:
@@ -159,14 +199,14 @@ def print_calendar(
     v_shift = max(0, v_shift)
     h_shift = max(0, h_shift)
     datetime_timezone = datetime_lib.datetime.now(tz=tz)
-    date_timezone_str = datetime_timezone.strftime(DATE_FORMAT)
+    date_timezone_str = datetime_timezone.strftime(DATE_FORMATS_MAP[date_format])
     print('\n' * v_shift, end='')
     print(" " * h_shift, end='')
     print("Today: {date}".format(date=date_timezone_str))
     print(" " * h_shift, end='')
     print("Timezone: {timezone}\n".format(timezone=timezone_str))
     calendar_str = calendar_obj.formatmonth(datetime_timezone.year, datetime_timezone.month)
-    if mode == "year":
+    if mode == "YEAR":
         calendar_str = calendar_obj.formatyear(datetime_timezone.year)
     print("\n".join([" " * h_shift + x for x in calendar_str.split("\n")]))
 
@@ -182,7 +222,8 @@ def run_clock(
         hide_date: bool = False,
         hide_timezone: bool = False,
         am_pm: bool = False,
-        date_system: str = "gregorian") -> None:
+        date_system: str = "GREGORIAN",
+        date_format: str = "FULL") -> None:
     """
     Run clock.
 
@@ -197,9 +238,10 @@ def run_clock(
     :param hide_timezone: hide timezone flag
     :param am_pm: AM/PM mode flag
     :param date_system: date system
+    :param date_format: date format
     """
     datetime_lib = datetime
-    if date_system == "jalali":
+    if date_system == "JALALI":
         datetime_lib = jdatetime
     format_index = 0
     time_formats = HORIZONTAL_TIME_12H_FORMATS if am_pm else HORIZONTAL_TIME_24H_FORMATS
@@ -224,7 +266,7 @@ def run_clock(
         print(" " * h_shift, end='')
         datetime_timezone = datetime_lib.datetime.now(tz=tz)
         time_timezone_str = datetime_timezone.strftime(time_formats[format_index])
-        date_timezone_str = datetime_timezone.strftime(DATE_FORMAT)
+        date_timezone_str = datetime_timezone.strftime(DATE_FORMATS_MAP[date_format])
         tprint(time_timezone_str, font=face, sep="\n" + " " * h_shift)
         if not hide_date:
             print(" " * h_shift, end='')
@@ -256,18 +298,22 @@ def main() -> None:
     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('--countries-list', help='countries list', nargs="?", const=1)
+    parser.add_argument('--date-formats-list', help='date formats 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.lower, choices=CALENDARS_LIST)
+    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])
+    parser.add_argument('--date-format', help='date format', type=str.upper, choices=DATE_FORMATS_LIST, default="FULL")
     parser.add_argument(
         '--date-system',
         help='date system',
-        type=str.lower,
+        type=str.upper,
         choices=DATE_SYSTEMS_LIST,
-        default="gregorian")
+        default="GREGORIAN")
     args = parser.parse_args()
     if args.version:
         print(CLOX_VERSION)
@@ -279,6 +325,8 @@ def main() -> None:
         show_timezones_list(args.country)
     elif args.countries_list:
         show_countries_list()
+    elif args.date_formats_list:
+        show_date_formats_list(date_system=args.date_system)
     elif args.calendar:
         print_calendar(
             mode=args.calendar,
@@ -286,7 +334,9 @@ def main() -> None:
             country=args.country,
             h_shift=args.h_shift,
             v_shift=args.v_shift,
-            date_system=args.date_system)
+            date_system=args.date_system,
+            date_format=args.date_format,
+            first_weekday=args.first_weekday)
     else:
         try:
             run_clock(
@@ -300,6 +350,7 @@ def main() -> None:
                 hide_date=args.hide_date,
                 hide_timezone=args.hide_timezone,
                 am_pm=args.am_pm,
-                date_system=args.date_system)
+                date_system=args.date_system,
+                date_format=args.date_format)
         except (KeyboardInterrupt, EOFError):
             print(EXIT_MESSAGE)

{clox-1.0 → clox-1.1}/clox/params.py

@@ -2,7 +2,7 @@
 """clox params."""
 import pytz
 
-CLOX_VERSION = "1.0"
+CLOX_VERSION = "1.1"
 
 CLOX_OVERVIEW = '''
 Clox is a terminal-based clock application designed for terminal enthusiasts who appreciate simplicity,
@@ -22,9 +22,9 @@ 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"
 TIMEZONE_DIFFERENCE_FORMAT = "{hours:02}h{minutes:02}m {direction}"
 
+WEEKDAYS_LIST = ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"]
 TIMEZONES_LIST = list(map(lambda x: x.upper(), pytz.all_timezones))
 COUNTRIES_LIST = list(map(lambda x: x.upper(), pytz.country_timezones.keys()))
 
@@ -57,8 +57,24 @@ FACES_MAP = {
     25: 'epic',
 }
 
+DATE_FORMATS_MAP = {
+    'ISO': '%Y-%m-%d',
+    'US': '%m/%d/%Y',
+    'US-SHORT': '%m/%d/%y',
+    'EU': '%d/%m/%Y',
+    'EU-SHORT': '%d/%m/%y',
+    'DOT': '%d.%m.%Y',
+    'DASH': '%d-%m-%Y',
+    'YMD': '%Y/%m/%d',
+    'DMY': '%d/%m/%Y',
+    'MDY': '%m/%d/%Y',
+    'FULL': '%A, %B %d, %Y',
+}
+
 FACES_LIST = [-1] + sorted(FACES_MAP)
 
-CALENDARS_LIST = ["month", "year"]
+CALENDARS_LIST = ["MONTH", "YEAR"]
+
+DATE_SYSTEMS_LIST = ["GREGORIAN", "JALALI"]
 
-DATE_SYSTEMS_LIST = ["gregorian", "jalali"]
+DATE_FORMATS_LIST = sorted(DATE_FORMATS_MAP)

{clox-1.0 → clox-1.1}/clox.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: clox
-Version: 1.0
+Version: 1.1
 Summary: A Geeky Clock for Terminal Enthusiasts
 Home-page: https://github.com/sepandhaghighi/clox
-Download-URL: https://github.com/sepandhaghighi/clox/tarball/v1.0
+Download-URL: https://github.com/sepandhaghighi/clox/tarball/v1.1
 Author: Sepand Haghighi
 Author-email: me@sepand.tech
 License: MIT
@@ -104,13 +104,13 @@ Clox is a terminal-based clock application designed for terminal enthusiasts who
 ## Installation		
 
 ### Source Code
-- Download [Version 1.0](https://github.com/sepandhaghighi/clox/archive/v1.0.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)
+- Download [Version 1.1](https://github.com/sepandhaghighi/clox/archive/v1.1.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==1.0`						
+- `pip install clox==1.1`						
 
 
 ## Usage
@@ -218,22 +218,33 @@ clox --vertical
 
 In this mode, the calendar will be displayed
 
-ℹ️ Valid choices: [`month`, `year`]
+ℹ️ Valid choices: [`MONTH`, `YEAR`]
 
 ```console
-clox --calendar=month
+clox --calendar=month --first-weekday="SUNDAY"
 ```
 
 ### Date System
 
-ℹ️ Valid choices: [`gregorian`, `jalali`]
+ℹ️ Valid choices: [`GREGORIAN`, `JALALI`]
 
-ℹ️ The default date system is `gregorian`
+ℹ️ The default date system is `GREGORIAN`
 
 ```console
 clox --date-system=jalali
 ```
 
+### Date Format
+
+ℹ️ Valid choices: [`ISO`, `US`, `US-SHORT`, `EU`, `EU-SHORT`, `DOT`, `DASH`, `YMD`, `DMY`, `MDY`, `FULL`]
+
+ℹ️ The default date format is `FULL`
+
+```console
+clox --date-system=jalali --date-format=EU
+```
+* Date Formats List: `clox --date-formats-list`
+
 ## Screen Record
 
 <div align="center">
@@ -292,6 +303,14 @@ 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]
+## [1.1] - 2025-05-23
+### Added
+- `--first-weekday` argument
+- `--date-format` argument
+- `--date-formats-list` argument
+### Changed
+- `README.md` updated
+- Test system modified
 ## [1.0] - 2025-05-06
 ### Added
 - Local time
@@ -358,7 +377,8 @@ 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/v1.0...dev
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v1.1...dev
+[1.1]: https://github.com/sepandhaghighi/clox/compare/v1.0...v1.1
 [1.0]: https://github.com/sepandhaghighi/clox/compare/v0.9...v1.0
 [0.9]: https://github.com/sepandhaghighi/clox/compare/v0.8...v0.9
 [0.8]: https://github.com/sepandhaghighi/clox/compare/v0.7...v0.8

{clox-1.0 → clox-1.1}/setup.py

@@ -30,7 +30,7 @@ def read_description() -> str:
 setup(
     name='clox',
     packages=['clox'],
-    version='1.0',
+    version='1.1',
     description='A Geeky Clock 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/clox',
-    download_url='https://github.com/sepandhaghighi/clox/tarball/v1.0',
+    download_url='https://github.com/sepandhaghighi/clox/tarball/v1.1',
     keywords="clock time timer timezone terminal cli geek clox",
     project_urls={
         'Source': 'https://github.com/sepandhaghighi/clox'