# world-wall-clock
**world-wall-clock** is a TUI application that provides a multi-timezone
graphical clock in a terminal environment.
## Installing world-wall-clock
You can install world-wall-clock with the Python packaging tool
[pip](https://pip.pypa.io/en/stable/). It is recommended to do so in a
[virtual environment](https://docs.python.org/3/library/venv.html).
Alternatively, you can use [pipx](https://pypa.github.io/pipx/) as a wrapper
around pip that will handle setting up a virtual environment for you.
### From PyPI, using pipx
```sh
pipx install world-wall-clock
```
### From PyPI, using pip in a virtual enviornment
```sh
python -m pip install world-wall-clock
```
### From the top level of the source repo, using pip in a virtual environment
```sh
python -m pip install .
```
## Running world-wall-clock
In an environment with world-wall-clock installed, start it from the command
line with:
```sh
wwclock
```
or
```sh
python -m world_wall_clock
```
## Usage
world-wall-clock is a graphical application. By default it shows a live view of
one local clock (the system time) and clocks for several time zones scattered
around the world. By navigating using arrow keys and selecting or deselecting
items from the sidebar of available timezones using the `Enter` or `Space` key,
you can customize the list of displayed clocks. This is silently stored in the
application configuration directory for the next time you launch
world-wall-clock.
Using the "Custom time" radio button, you can switch the application into custom
time mode. Edit the custom time to display by navigating to the numerical
datetime fields next to the custom time button and typing over their current
values (these are edited in "replace" rather than "insert" mode). The reference
timezone for the custom time can be changed by navigating up or down from the
timezone listed at the end of the custom time fields; the list of timezones
you can pick from here is populated from the timezones of your displayed clocks.
## Dependencies
world-wall-clock is a Python 3 application that relies on
[urwid](https://urwid.org/) as its terminal widget toolkit,
[xdg-base-dirs](https://github.com/srstevenson/xdg-base-dirs) to determine where
to keep the application configuration, and
[tzdata](https://github.com/python/tzdata) to provide backup timezone
information if this is not already present on the system.
## Development
world-wall-clock uses [Poetry](https://python-poetry.org/) to manage builds and
dependencies. The Python code is formatted using
[Black](https://github.com/psf/black).
With Poetry installed, set up a Poetry environment with all of
world-wall-clock's runtime and dev dependencies; from the top level of the
source repo, run:
```sh
poetry install
```
Now you can modify the source code and run the application with any changes
you've made using the `poetry run` command:
```sh
poetry run wwclock
```
The `poetry run` command will also allow you to run the suite of chosen dev
tools for static type-checking, import sorting, code formatting, and linting:
```sh
poetry run mypy --strict
poetry run isort .
poetry run black .
poetry run flake8
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ddelabru/world-wall-clock",
"name": "world-wall-clock",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Dominic Delabruere",
"author_email": "dominic.delabruere@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ed/ea/2c35aa8a468aa29ceea45c60473d26b81d4bd76e3718a1190c702288ff59/world_wall_clock-0.1.5.tar.gz",
"platform": null,
"description": "# world-wall-clock\n\n**world-wall-clock** is a TUI application that provides a multi-timezone\ngraphical clock in a terminal environment.\n\n\n\n## Installing world-wall-clock\n\nYou can install world-wall-clock with the Python packaging tool\n[pip](https://pip.pypa.io/en/stable/). It is recommended to do so in a\n[virtual environment](https://docs.python.org/3/library/venv.html).\nAlternatively, you can use [pipx](https://pypa.github.io/pipx/) as a wrapper\naround pip that will handle setting up a virtual environment for you.\n\n### From PyPI, using pipx\n\n```sh\npipx install world-wall-clock\n```\n\n### From PyPI, using pip in a virtual enviornment\n\n```sh\npython -m pip install world-wall-clock\n```\n\n### From the top level of the source repo, using pip in a virtual environment\n\n```sh\npython -m pip install .\n```\n\n## Running world-wall-clock\n\nIn an environment with world-wall-clock installed, start it from the command\nline with:\n\n```sh\nwwclock\n```\n\nor\n\n```sh\npython -m world_wall_clock\n```\n\n## Usage\n\nworld-wall-clock is a graphical application. By default it shows a live view of\none local clock (the system time) and clocks for several time zones scattered\naround the world. By navigating using arrow keys and selecting or deselecting\nitems from the sidebar of available timezones using the `Enter` or `Space` key,\nyou can customize the list of displayed clocks. This is silently stored in the\napplication configuration directory for the next time you launch\nworld-wall-clock.\n\nUsing the \"Custom time\" radio button, you can switch the application into custom\ntime mode. Edit the custom time to display by navigating to the numerical\ndatetime fields next to the custom time button and typing over their current\nvalues (these are edited in \"replace\" rather than \"insert\" mode). The reference\ntimezone for the custom time can be changed by navigating up or down from the\ntimezone listed at the end of the custom time fields; the list of timezones\nyou can pick from here is populated from the timezones of your displayed clocks.\n\n## Dependencies\n\nworld-wall-clock is a Python 3 application that relies on\n[urwid](https://urwid.org/) as its terminal widget toolkit,\n[xdg-base-dirs](https://github.com/srstevenson/xdg-base-dirs) to determine where\nto keep the application configuration, and\n[tzdata](https://github.com/python/tzdata) to provide backup timezone\ninformation if this is not already present on the system.\n\n## Development\n\nworld-wall-clock uses [Poetry](https://python-poetry.org/) to manage builds and\ndependencies. The Python code is formatted using\n[Black](https://github.com/psf/black).\n\nWith Poetry installed, set up a Poetry environment with all of\nworld-wall-clock's runtime and dev dependencies; from the top level of the\nsource repo, run:\n\n```sh\npoetry install\n```\n\nNow you can modify the source code and run the application with any changes\nyou've made using the `poetry run` command:\n\n```sh\npoetry run wwclock\n```\n\nThe `poetry run` command will also allow you to run the suite of chosen dev\ntools for static type-checking, import sorting, code formatting, and linting:\n\n```sh\npoetry run mypy --strict\npoetry run isort .\npoetry run black .\npoetry run flake8\n```\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "TUI world clock application",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/ddelabru/world-wall-clock",
"Repository": "https://github.com/ddelabru/world-wall-clock"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ae289556b8ef29421fcf726fd42e27442079e8212f6369f9ecb1f220a374ebfc",
"md5": "0ecb4d2b9f407252e3cbe6931d3921bf",
"sha256": "9cd47bc66ad15c5c41333edde9917ce95b7906dbc34a28e58a58a016cc234a57"
},
"downloads": -1,
"filename": "world_wall_clock-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ecb4d2b9f407252e3cbe6931d3921bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 20965,
"upload_time": "2025-07-08T19:37:26",
"upload_time_iso_8601": "2025-07-08T19:37:26.809311Z",
"url": "https://files.pythonhosted.org/packages/ae/28/9556b8ef29421fcf726fd42e27442079e8212f6369f9ecb1f220a374ebfc/world_wall_clock-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "edea2c35aa8a468aa29ceea45c60473d26b81d4bd76e3718a1190c702288ff59",
"md5": "d58552fddc452053ac4bcfa6829ab754",
"sha256": "481d7ce993ecbee71285396f743aba9544be75310067c487a956d5ad57a9dc3c"
},
"downloads": -1,
"filename": "world_wall_clock-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "d58552fddc452053ac4bcfa6829ab754",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 19299,
"upload_time": "2025-07-08T19:37:27",
"upload_time_iso_8601": "2025-07-08T19:37:27.919643Z",
"url": "https://files.pythonhosted.org/packages/ed/ea/2c35aa8a468aa29ceea45c60473d26b81d4bd76e3718a1190c702288ff59/world_wall_clock-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 19:37:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ddelabru",
"github_project": "world-wall-clock",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "world-wall-clock"
}
JSON
