Metadata-Version: 2.4
Name: py-clocks
Version: 26.0.2
Summary: The py-clocks package is a Python-based project designed for displaying multiple timezone clocks in windows desktop.
Project-URL: homepage, https://github.com/chaitu-ycr/py-clocks
Project-URL: repository, https://github.com/chaitu-ycr/py-clocks
Project-URL: documentation, https://chaitu-ycr.github.io/py-clocks
Author-email: chaitu-ycr <chaitu.ycr@gmail.com>
License: MIT License
        
        Copyright (c) 2026 chaitu-ycr
        
        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.
License-File: LICENSE
Keywords: clocks,desktop,python,timezone
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
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: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: dearpygui
Requires-Dist: pyinstaller
Requires-Dist: pytz
Description-Content-Type: text/markdown

# py_clocks

`py_clocks` is a native desktop clock utility built with **DearPyGui**.

It provides three always-on productivity windows:

1. **World Clocks**
   - View multiple timezone clocks.
   - Add new clocks dynamically.
   - Search and select timezones from the IANA timezone list.

2. **Stopwatch**
   - Start / Pause / Lap / Reset controls.
   - Live precision display with lap history.

3. **Wellness Alerts**
   - Built-in reminders:
     - Close eyes every 30 minutes
     - Take a 2-minute walk every 60 minutes
   - Add custom alerts with your own interval.
   - Visual alert window border glow/pulse when reminders trigger.

## Tech Stack

- Python 3.10+
- [DearPyGui](https://github.com/hoffstadt/DearPyGui)
- pytz

## Installation

```bash
pip install -e .
```

## Run the App

```bash
python src/py_clocks/app.py
```

## Build an Executable (PyInstaller)

```bash
pyinstaller --onefile src/py_clocks/app.py
```

Generated executable:

- `dist/app.exe` (or platform-specific output name)

## Notes

- The app currently uses a fixed viewport/layout tuned for desktop usage.
- Timezone values use standard IANA timezone names such as `America/New_York` or `Europe/Berlin`.

## Documentation

- [Source manual](https://chaitu-ycr.github.io/py-clocks/source-manual)
