Metadata-Version: 2.4
Name: zen-timer
Version: 0.2.1
Summary: 🧘 Deep-work timer. Simple terminal app for focus sessions. No GUI, just flow.
Author-email: Shenal Diluksha <shenald@users.noreply.github.com>
Maintainer-email: shenald-dev <shenald@users.noreply.github.com>
License: MIT
Project-URL: Homepage, https://github.com/shenald-dev/zen
Project-URL: Documentation, https://github.com/shenald-dev/zen#readme
Project-URL: Repository, https://github.com/shenald-dev/zen
Project-URL: Issues, https://github.com/shenald-dev/zen/issues
Project-URL: Changelog, https://github.com/shenald-dev/zen/blob/main/CHANGELOG.md
Keywords: zen,timer,pomodoro,focus,deep-work,cli,tui,productivity
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich<16.0.0,>=13.9.0
Requires-Dist: typer<1.0.0,>=0.12.0
Provides-Extra: dev
Requires-Dist: pytest<10.0.0,>=8.0.0; extra == "dev"
Requires-Dist: pytest-mock<4.0.0,>=3.14.0; extra == "dev"
Requires-Dist: pytest-cov<8.0.0,>=5.0.0; extra == "dev"
Requires-Dist: flake8<8.0.0,>=7.0.0; extra == "dev"
Requires-Dist: pylint<5.0.0,>=3.0.0; extra == "dev"
Dynamic: license-file

<div align="center">
  <img src="https://raw.githubusercontent.com/shenald-dev/zen/main/assets/logo.png" alt="zen Logo" width="250" />
  
  <br/>

  <h1>🧘‍♂️ zen</h1>
  <p><b>Minimalist Terminal Deep-Work Timer</b></p>
  <i>Simple terminal app for focus sessions. No GUI, just flow.</i>

  <br/>
  
  [![PyPI version](https://img.shields.io/pypi/v/zen-timer.svg)](https://pypi.org/project/zen-timer/)
  [![Python](https://img.shields.io/badge/Python-3.10%2B-blue.svg)](https://python.org)
  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
</div>

---

## 📑 Table of Contents
- [🌟 Overview](#-overview)
- [🚀 Enterprise Features](#-enterprise-features)
- [⚡ Quick Start Guide](#-quick-start-guide)
- [💻 Comprehensive Usage](#-comprehensive-usage)
- [🤝 Contributing](#-contributing)

---

## 🌟 Overview

**zen** is an ultra-minimalist, distraction-free terminal application built to safeguard developer focus. It ditches complex GUIs in favor of beautiful, native terminal progress indicators. Dive straight into flow state.

---

## 🚀 Enterprise Features

- **🌊 Flow State**: Visually stunning, distraction-free TUI progress bar.
- **⏱️ Flexible**: Fully configurable focus sessions and break reminders.
- **🎨 Premium Aesthetic**: Powered by `Rich` and `Typer` to look incredible in any modern terminal emulator (iTerm, Kitty, Windows Terminal).
- **🚀 Performance**: Lightning-fast startup with lazy-loaded imports and zero-overhead UI rendering.

---

## ⚡ Quick Start Guide

### Installation

Install directly via `pip`:
```bash
pip install zen-timer
```

Or install via `pipx` or `uv`:
```bash
pipx install zen-timer
# or
uv tool install zen-timer
```
---

## 💻 Comprehensive Usage

### Start a Session
To start a default 25-minute Pomodoro session:
```bash
zen
```
### Advanced Usage

**zen** supports additional CLI flags to customize your workflow:

- **`--break`**: Run the timer as a break session instead of a focus session. Ideal for timing your rest periods between deep work blocks.
  ```bash
  zen 5 --break
  ```

- **`--silent`**: Run the timer without sending desktop notifications upon completion. Perfect for environments where notifications are distracting or unsupported.
  ```bash
  zen 25 --silent
  ```

You can also combine these flags for a silent break session:
```bash
zen 15 --break --silent
```
---

## 🤝 Contributing
Want to help safeguard developer focus? Let's flow together! 🌊
- 🐛 **Found a bug?** Open an issue to let us know.
- ✨ **Have a feature idea?** We are open to PRs! Keep the UI minimal and the code beautiful.
- 🎨 **Documentation tweaks?** Always welcome!

---
> *Crafted by a Vibe Coder. Protect your focus.*
