clox 0.0.0__py3-none-any.whl → 0.1__py3-none-any.whl

clox/__init__.py

@@ -1,2 +1,4 @@
-# -*- coding: utf-8 -*-
-"""clox modules."""
+# -*- coding: utf-8 -*-
+"""clox modules."""
+from clox.params import CLOX_VERSION
+__version__ = CLOX_VERSION

clox/__main__.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+"""clox main."""
+from .functions import main
+
+
+if __name__ == "__main__":
+    main()

clox/functions.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+"""clox functions."""
+import os
+import sys
+import time
+import random
+import datetime
+import argparse
+import pytz
+from art import tprint
+from .params import TIMEZONES_LIST, CLOX_VERSION
+from .params import ADDITIONAL_INFO, EXIT_MESSAGE
+from .params import FACES_MAP, FACES_LIST, FACES_LIST_EXAMPLE_MESSAGE
+
+
+def clear_screen():
+    """
+    Clear screen function.
+
+    :return: None
+    """
+    if sys.platform == "win32":
+        os.system('cls')
+    else:
+        os.system('clear')
+
+
+def get_face(index):
+    """
+    Return face name.
+
+    :param index: face index
+    :type index: int
+    :return: face name as str
+    """
+    if index == -1:
+        index = random.choice(sorted(FACES_MAP))
+    return FACES_MAP[index]
+
+
+def show_faces_list():
+    """
+    Show faces list.
+
+    :return: None
+    """
+    print("Faces list:\n")
+    for i in sorted(FACES_MAP):
+        print('Face {}\n'.format(i))
+        tprint(FACES_LIST_EXAMPLE_MESSAGE, font=get_face(i))
+        print('=' * 80)
+
+
+def show_timezones_list():
+    """
+    Show timezones list.
+
+    :return: None
+    """
+    print("Timezones list:\n")
+    for index, timezone in enumerate(TIMEZONES_LIST, 1):
+        print("{0}. {1}".format(index, timezone))
+
+
+def run_clock(timezone=None, v_shift=0, h_shift=0, face=1):
+    """
+    Run clock.
+
+    :param timezone: timezone
+    :type timezone: str
+    :param v_shift: vertical shift
+    :type v_shift: int
+    :param h_shift: horizontal shift
+    :type h_shift: int
+    :param face: face index
+    :type face: int
+    :return: None
+    """
+    timezone_str = timezone
+    if timezone is None:
+        tz = None
+        timezone_str = "Local"
+    else:
+        tz = pytz.timezone(timezone)
+    v_shift = max(0, v_shift)
+    h_shift = max(0, h_shift)
+    face = get_face(face)
+    while True:
+        clear_screen()
+        print('\n' * v_shift, end='')
+        print(" " * h_shift, end='')
+        current_time = datetime.datetime.now(tz=tz).strftime('%H:%M')
+        tprint(current_time, font=face, sep="\n" + " " * h_shift)
+        print(" " * h_shift, end='')
+        print("Timezone: {0}".format(timezone_str))
+        time.sleep(1)
+
+
+def main():
+    """
+    CLI main function.
+
+    :return: None
+    """
+    parser = argparse.ArgumentParser()
+    parser.epilog = ADDITIONAL_INFO
+    parser.add_argument('--timezone', help='timezone', type=str, choices=TIMEZONES_LIST)
+    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('--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)
+    args = parser.parse_args()
+    if args.version:
+        print(CLOX_VERSION)
+    elif args.faces_list:
+        show_faces_list()
+    elif args.timezones_list:
+        show_timezones_list()
+    else:
+        try:
+            run_clock(timezone=args.timezone, h_shift=args.h_shift, v_shift=args.v_shift, face=args.face)
+        except (KeyboardInterrupt, EOFError):
+            print(EXIT_MESSAGE)

clox/params.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+"""clox params."""
+import pytz
+
+CLOX_VERSION = "0.1"
+
+ADDITIONAL_INFO = "Additional information: Press `Ctrl+C` to exit."
+EXIT_MESSAGE = "See you. Bye!"
+
+FACES_LIST_EXAMPLE_MESSAGE = "12 : 34"
+
+TIMEZONES_LIST = pytz.all_timezones
+
+
+FACES_MAP = {
+    1: 'bulbhead',
+    2: 'soft',
+    3: '4max',
+    4: '5x7',
+    5: 'charact4',
+    6: 'o8',
+    7: 'alphabet',
+    8: 'shadow',
+    9: 'speed',
+    10: 'rounded',
+    11: 'chartri',
+    12: 'standard',
+    13: 'contessa',
+    14: 'avatar',
+    15: 'mini',
+    16: 'twopoint',
+    17: '3x5',
+    18: 'threepoint',
+    19: 'ascii_new_roman',
+    20: 'serifcap',
+    21: 'lockergnome',
+    22: 'dotmatrix',
+    23: '3-d',
+    24: 'sweet',
+    25: 'epic',
+}
+
+FACES_LIST = [-1] + sorted(FACES_MAP)

clox-0.1.dist-info/AUTHORS.md

@@ -0,0 +1,6 @@
+# Core Developers
+----------
+- [@sepandhaghighi](http://github.com/sepandhaghighi)
+
+# Other Contributors
+----------

clox-0.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sepand Haghighi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

clox-0.1.dist-info/METADATA

@@ -0,0 +1,207 @@
+Metadata-Version: 2.1
+Name: clox
+Version: 0.1
+Summary: A Geeky Clock for Terminal Enthusiasts
+Home-page: https://github.com/sepandhaghighi/clox
+Download-URL: https://github.com/sepandhaghighi/clox/tarball/v0.1
+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: Natural Language :: English
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Other Audience
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Utilities
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.md
+Requires-Dist: art>=5.3
+Requires-Dist: pytz>=2019.2
+
+
+<div align="center">
+<h1>Clox: A Geeky Clock for Terminal Enthusiasts</h1>
+<br/>
+<a href="https://badge.fury.io/py/clox"><img src="https://badge.fury.io/py/clox.svg" alt="PyPI version"></a>
+<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
+<a href="https://github.com/sepandhaghighi/clox"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/sepandhaghighi/clox"></a>
+</div>			
+				
+## Overview	
+
+<p align="justify">					
+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.
+</p>
+
+<table>
+	<tr>
+		<td align="center">PyPI Counter</td>
+		<td align="center"><a href="http://pepy.tech/project/clox"><img src="http://pepy.tech/badge/clox"></a></td>
+	</tr>
+	<tr>
+		<td align="center">Github Stars</td>
+		<td align="center"><a href="https://github.com/sepandhaghighi/clox"><img src="https://img.shields.io/github/stars/sepandhaghighi/clox.svg?style=social&label=Stars"></a></td>
+	</tr>
+</table>
+
+
+
+<table>
+	<tr> 
+		<td align="center">Branch</td>
+		<td align="center">main</td>	
+		<td align="center">dev</td>	
+	</tr>
+	<tr>
+		<td align="center">CI</td>
+		<td align="center"><img src="https://github.com/sepandhaghighi/clox/actions/workflows/test.yml/badge.svg?branch=main"></td>
+		<td align="center"><img src="https://github.com/sepandhaghighi/clox/actions/workflows/test.yml/badge.svg?branch=dev"></td>
+	</tr>
+</table>
+
+
+<table>
+	<tr> 
+		<td align="center">Code Quality</td>
+		<td align="center"><a href="https://www.codefactor.io/repository/github/sepandhaghighi/clox"><img src="https://www.codefactor.io/repository/github/sepandhaghighi/clox/badge" alt="CodeFactor"></a></td>
+		<td align="center"><a href="https://app.codacy.com/gh/sepandhaghighi/clox/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/4cd4cd3b20b1474fb674823b1b417b76"></a></td>
+		<td align="center"><a href="https://codebeat.co/projects/github-com-sepandhaghighi-clox-main"><img alt="codebeat badge" src="https://codebeat.co/badges/19394d3a-009b-401b-b376-24a325ef2fdf"></a></td>
+	</tr>
+</table>
+
+
+## Installation		
+
+### Source Code
+- Download [Version 0.1](https://github.com/sepandhaghighi/clox/archive/v0.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==0.1`						
+
+
+## Usage
+
+ℹ️ You can use `clox` or `python -m clox` to run this program
+
+### Version
+
+```console
+clox --version
+```
+
+### Basic
+
+ℹ️ Press `Ctrl + C` to exit
+
+```console
+clox
+```
+
+### Face
+
+```console
+clox --face=3
+```
+* Use `--face=-1` for random mode
+* [Faces List](https://github.com/sepandhaghighi/clox/blob/main/FACES.md)
+* `clox --faces-list`
+
+### Timezone
+
+```console
+clox --timezone="Etc/GMT+7"
+```
+* [Timezones List](https://github.com/sepandhaghighi/clox/blob/main/TIMEZONES.md)
+* `clox --timezones-list`
+
+### Vertical/Horizontal Shift
+
+ℹ️ The vertical and horizontal shift both have default values of `0`
+
+```console
+clox --v-shift=20 --h-shift=30
+```
+
+## Issues & Bug Reports			
+
+Just fill an issue and describe it. We'll check it ASAP!
+
+- Please complete the issue template
+ 			
+
+## Show Your Support
+								
+<h3>Star This Repo</h3>					
+
+Give a ⭐️ if this project helped you!
+
+<h3>Donate to Our Project</h3>	
+
+<h4>Bitcoin</h4>
+1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy
+<h4>Ethereum</h4>
+0xcD4Db18B6664A9662123D4307B074aE968535388
+<h4>Litecoin</h4>
+Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ
+<h4>Doge</h4>
+DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh
+<h4>Tron</h4>
+TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7
+<h4>Ripple</h4>
+rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq
+<h4>Binance Coin</h4>
+bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef
+<h4>Tether</h4>
+0xcD4Db18B6664A9662123D4307B074aE968535388
+<h4>Dash</h4>
+Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s
+<h4>Stellar</h4>		
+GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL
+<h4>Zilliqa</h4>
+zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5
+<h4>Coffeete</h4>
+<a href="http://www.coffeete.ir/opensource">
+<img src="http://www.coffeete.ir/images/buttons/lemonchiffon.png" style="width:260px;" />
+</a>
+
+
+# Changelog
+All notable changes to this project will be documented in this file.
+
+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.1] - 2024-12-24
+### Added
+- `--v-shift` and `--h-shift` arguments
+- `--timezone` argument
+- `--face` argument
+- `run_clock` and `main` functions
+- `TIMEZONES.md`
+- `FACES.md`
+
+[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.1...dev
+[0.1]: https://github.com/sepandhaghighi/clox/compare/e9b49e2...v0.1
+
+
+

clox-0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+clox/__init__.py,sha256=gErclFSjUDschQpngWqOBGkBKt1jwd-Ww8B9iJmlU5s,108
+clox/__main__.py,sha256=9oJYc1WXu4ZMrjKny_2-4Cgu46-VWHuE9xOqD1iJY0E,109
+clox/functions.py,sha256=auoQrYu-dbFYoxxUpO2rILUvQP4OhQ5497gyBSLcKgQ,3289
+clox/params.py,sha256=e6w8otviH0lPKIsfeyoC5yuH4YYsgCXls_2hKTc1xPM,766
+clox-0.1.dist-info/AUTHORS.md,sha256=1T_gvCIPkHMdGX9e6dg9eich7OiqlYkE6hSk8tieihQ,116
+clox-0.1.dist-info/LICENSE,sha256=WoAsqqZ_lNVBGdyxjwh7YnVNXKfOB-qYVrRhrn-e-_4,1072
+clox-0.1.dist-info/METADATA,sha256=Fsl1FcPmVi_Og76AInSa4C1A_VgUBayEMJuuqMujAiU,6484
+clox-0.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+clox-0.1.dist-info/entry_points.txt,sha256=sP4Rmoe-DxYGjlF_Tld6nghbt_u-fK8h9ZUQFmO8TJs,45
+clox-0.1.dist-info/top_level.txt,sha256=5DxGH-4VNfYkM8vbfngObh6-jpFEoSW4M90EvDGfhSw,5
+clox-0.1.dist-info/RECORD,,

{clox-0.0.0.dist-info → clox-0.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

clox-0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+clox = clox.functions:main

clox-0.0.0.dist-info/METADATA

@@ -1,25 +0,0 @@
-Metadata-Version: 2.1
-Name: clox
-Version: 0.0.0
-Summary: This name has been reserved using Reserver
-Home-page: https://url.com
-Download-URL: https://download_url.com
-Author: Development Team
-Author-email: test@test.com
-License: MIT
-Project-URL: Source, https://github.com/source
-Keywords: python3 python reserve reserver reserved
-Classifier: Development Status :: 1 - Planning
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-
-
-    This name has been reserved using [Reserver](https://github.com/openscilab/reserver).
-    

clox-0.0.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-clox/__init__.py,sha256=RVjzBns3rl9-B1WcUV_e0jpPcRPw_xNp97tLgeWoBWY,44
-clox-0.0.0.dist-info/METADATA,sha256=qfCtaKbIV_K0XEf1dOP1pqDc8ozX33V-bGyt7teo2Hc,915
-clox-0.0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-clox-0.0.0.dist-info/top_level.txt,sha256=5DxGH-4VNfYkM8vbfngObh6-jpFEoSW4M90EvDGfhSw,5
-clox-0.0.0.dist-info/RECORD,,