<div align="center">
<img src="https://github.com/sepandhaghighi/clox/raw/main/otherfiles/logo.png" width="450">
<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.4](https://github.com/sepandhaghighi/clox/archive/v0.4.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`
## Usage
ℹ️ You can use `clox` or `python -m clox` to run this program
### Version
```console
clox --version
```
### Info
```console
clox --info
```
### 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
```
### No Blink
Disable blinking mode
```console
clox --no-blink
```
### Vertical Mode
```console
clox --vertical
```
## 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.4] - 2025-01-18
### Added
- Date
- `--info` argument
## [0.3] - 2025-01-10
### Added
- Logo
- `--vertical` argument
### Changed
- `show_faces_list` function updated
- `AUTHORS.md` updated
## [0.2] - 2025-01-01
### Added
- Blink mode
- `--no-blink` argument
### Changed
- `README.md` updated
## [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.4...dev
[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
Raw data
{
"_id": null,
"home_page": "https://github.com/sepandhaghighi/clox",
"name": "clox",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "clock time timer timezone terminal cli geek clox",
"author": "Sepand Haghighi",
"author_email": "me@sepand.tech",
"download_url": "https://files.pythonhosted.org/packages/60/d2/7565cf662ed85cef1412db51c77c0cd23a4c00adc04b8c7e06876bb0a1af/clox-0.4.tar.gz",
"platform": null,
"description": "\n<div align=\"center\">\n<img src=\"https://github.com/sepandhaghighi/clox/raw/main/otherfiles/logo.png\" width=\"450\">\n<h1>Clox: A Geeky Clock for Terminal Enthusiasts</h1>\n<br/>\n<a href=\"https://badge.fury.io/py/clox\"><img src=\"https://badge.fury.io/py/clox.svg\" alt=\"PyPI version\"></a>\n<a href=\"https://www.python.org/\"><img src=\"https://img.shields.io/badge/built%20with-Python3-green.svg\" alt=\"built with Python3\"></a>\n<a href=\"https://github.com/sepandhaghighi/clox\"><img alt=\"GitHub repo size\" src=\"https://img.shields.io/github/repo-size/sepandhaghighi/clox\"></a>\n</div>\t\t\t\n\t\t\t\t\n## Overview\t\n\n<p align=\"justify\">\t\t\t\t\t\nClox 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.\n</p>\n\n<table>\n\t<tr>\n\t\t<td align=\"center\">PyPI Counter</td>\n\t\t<td align=\"center\"><a href=\"http://pepy.tech/project/clox\"><img src=\"http://pepy.tech/badge/clox\"></a></td>\n\t</tr>\n\t<tr>\n\t\t<td align=\"center\">Github Stars</td>\n\t\t<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>\n\t</tr>\n</table>\n\n\n\n<table>\n\t<tr> \n\t\t<td align=\"center\">Branch</td>\n\t\t<td align=\"center\">main</td>\t\n\t\t<td align=\"center\">dev</td>\t\n\t</tr>\n\t<tr>\n\t\t<td align=\"center\">CI</td>\n\t\t<td align=\"center\"><img src=\"https://github.com/sepandhaghighi/clox/actions/workflows/test.yml/badge.svg?branch=main\"></td>\n\t\t<td align=\"center\"><img src=\"https://github.com/sepandhaghighi/clox/actions/workflows/test.yml/badge.svg?branch=dev\"></td>\n\t</tr>\n</table>\n\n\n<table>\n\t<tr> \n\t\t<td align=\"center\">Code Quality</td>\n\t\t<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>\n\t\t<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>\n\t\t<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>\n\t</tr>\n</table>\n\n\n## Installation\t\t\n\n### Source Code\n- Download [Version 0.4](https://github.com/sepandhaghighi/clox/archive/v0.4.zip) or [Latest Source](https://github.com/sepandhaghighi/clox/archive/dev.zip)\n- `pip install .`\t\t\t\t\n\n### PyPI\n\n- Check [Python Packaging User Guide](https://packaging.python.org/installing/) \n- `pip install clox==0.4`\t\t\t\t\t\t\n\n\n## Usage\n\n\u2139\ufe0f You can use `clox` or `python -m clox` to run this program\n\n### Version\n\n```console\nclox --version\n```\n\n### Info\n\n```console\nclox --info\n```\n\n### Basic\n\n\u2139\ufe0f Press `Ctrl + C` to exit\n\n```console\nclox\n```\n\n### Face\n\n```console\nclox --face=3\n```\n* Use `--face=-1` for random mode\n* [Faces List](https://github.com/sepandhaghighi/clox/blob/main/FACES.md)\n* `clox --faces-list`\n\n### Timezone\n\n```console\nclox --timezone=\"Etc/GMT+7\"\n```\n* [Timezones List](https://github.com/sepandhaghighi/clox/blob/main/TIMEZONES.md)\n* `clox --timezones-list`\n\n### Vertical/Horizontal Shift\n\n\u2139\ufe0f The vertical and horizontal shift both have default values of `0`\n\n```console\nclox --v-shift=20 --h-shift=30\n```\n\n### No Blink\n\nDisable blinking mode\n\n```console\nclox --no-blink\n```\n\n### Vertical Mode\n\n```console\nclox --vertical\n```\n\n## Issues & Bug Reports\t\t\t\n\nJust fill an issue and describe it. We'll check it ASAP!\n\n- Please complete the issue template\n \t\t\t\n\n## Show Your Support\n\t\t\t\t\t\t\t\t\n<h3>Star This Repo</h3>\t\t\t\t\t\n\nGive a \u2b50\ufe0f if this project helped you!\n\n<h3>Donate to Our Project</h3>\t\n\n<h4>Bitcoin</h4>\n1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy\n<h4>Ethereum</h4>\n0xcD4Db18B6664A9662123D4307B074aE968535388\n<h4>Litecoin</h4>\nLdnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ\n<h4>Doge</h4>\nDDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh\n<h4>Tron</h4>\nTCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7\n<h4>Ripple</h4>\nrN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq\n<h4>Binance Coin</h4>\nbnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef\n<h4>Tether</h4>\n0xcD4Db18B6664A9662123D4307B074aE968535388\n<h4>Dash</h4>\nXd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s\n<h4>Stellar</h4>\t\t\nGALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL\n<h4>Zilliqa</h4>\nzil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5\n<h4>Coffeete</h4>\n<a href=\"http://www.coffeete.ir/opensource\">\n<img src=\"http://www.coffeete.ir/images/buttons/lemonchiffon.png\" style=\"width:260px;\" />\n</a>\n\n\n# Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)\nand this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).\n\n## [Unreleased]\n## [0.4] - 2025-01-18\n### Added\n- Date\n- `--info` argument\n## [0.3] - 2025-01-10\n### Added\n- Logo\n- `--vertical` argument\n### Changed\n- `show_faces_list` function updated\n- `AUTHORS.md` updated\n## [0.2] - 2025-01-01\n### Added\n- Blink mode\n- `--no-blink` argument\n### Changed\n- `README.md` updated\n## [0.1] - 2024-12-24\n### Added\n- `--v-shift` and `--h-shift` arguments\n- `--timezone` argument\n- `--face` argument\n- `run_clock` and `main` functions\n- `TIMEZONES.md`\n- `FACES.md`\n\n[Unreleased]: https://github.com/sepandhaghighi/clox/compare/v0.4...dev\n[0.4]: https://github.com/sepandhaghighi/clox/compare/v0.3...v0.4\n[0.3]: https://github.com/sepandhaghighi/clox/compare/v0.2...v0.3\n[0.2]: https://github.com/sepandhaghighi/clox/compare/v0.1...v0.2\n[0.1]: https://github.com/sepandhaghighi/clox/compare/e9b49e2...v0.1\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Geeky Clock for Terminal Enthusiasts",
"version": "0.4",
"project_urls": {
"Download": "https://github.com/sepandhaghighi/clox/tarball/v0.4",
"Homepage": "https://github.com/sepandhaghighi/clox",
"Source": "https://github.com/sepandhaghighi/clox"
},
"split_keywords": [
"clock",
"time",
"timer",
"timezone",
"terminal",
"cli",
"geek",
"clox"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8403b89f5105020a2a1413fda202d74950b99c7ffa75c799d8696bf2c0b05eb",
"md5": "b58a0229dd6c20216de52b43e3493662",
"sha256": "a95a9b57b833b6e4e8c03ef751bf9ec3d2db219a077613ebf180160bdf808a17"
},
"downloads": -1,
"filename": "clox-0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b58a0229dd6c20216de52b43e3493662",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8150,
"upload_time": "2025-01-18T17:32:26",
"upload_time_iso_8601": "2025-01-18T17:32:26.527435Z",
"url": "https://files.pythonhosted.org/packages/f8/40/3b89f5105020a2a1413fda202d74950b99c7ffa75c799d8696bf2c0b05eb/clox-0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60d27565cf662ed85cef1412db51c77c0cd23a4c00adc04b8c7e06876bb0a1af",
"md5": "121ad540531bb057da55e7b126c58bda",
"sha256": "92dba719781b2d423f88861065b6052b8286b5827c6d69a21191bb89e7c54c7b"
},
"downloads": -1,
"filename": "clox-0.4.tar.gz",
"has_sig": false,
"md5_digest": "121ad540531bb057da55e7b126c58bda",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 17548,
"upload_time": "2025-01-18T17:32:24",
"upload_time_iso_8601": "2025-01-18T17:32:24.737405Z",
"url": "https://files.pythonhosted.org/packages/60/d2/7565cf662ed85cef1412db51c77c0cd23a4c00adc04b8c7e06876bb0a1af/clox-0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-18 17:32:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sepandhaghighi",
"github_project": "clox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "art",
"specs": [
[
">=",
"5.3"
]
]
},
{
"name": "pytz",
"specs": [
[
">=",
"2019.2"
]
]
}
],
"lcname": "clox"
}