Skip to main content

README.md

zen Logo

🧘‍♂️ zen

Minimalist Terminal Deep-Work Timer

Simple terminal app for focus sessions. No GUI, just flow.

PyPI version Python License: MIT


📑 Table of Contents


🌟 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 via pip:

pip install zen-timer

💻 Comprehensive Usage

Start a Session

To start a default 25-minute Pomodoro session:

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.

    zen 5 --break
    
  • --silent: Run the timer without sending desktop notifications upon completion. Perfect for environments where notifications are distracting or unsupported.

    zen 25 --silent
    

You can also combine these flags for a silent break session:

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.

Metadata

Release files for zen-timer 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zen-timer 0.2.0
File Size Uploaded Provenance Actions
zen_timer-0.2.0.tar.gz 8.5 kB Without provenance Details for zen_timer-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for zen-timer 0.2.0
File Interpreter ABI Platform Actions
zen_timer-0.2.0-py3-none-any.whl Python 3 none any Details for zen_timer-0.2.0-py3-none-any.whl

Total release size: 15.1 kB

Release files / zen_timer-0.2.0.tar.gz

Download URL zen_timer-0.2.0.tar.gz
Size 8.5 kB
Tags Source
SHA-256 checksum
How to use checksums
c92ec9c194383b432939065cd7863a7f7055f2dfbff455a236d455dc657e8ede
BLAKE2b-256 checksum
How to use checksums
559455beb6cf7c28216e15029348240144830274f81dd1186ddfea9f68699aef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.0

Release files / zen_timer-0.2.0-py3-none-any.whl

Download URL zen_timer-0.2.0-py3-none-any.whl
Size 6.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b5f6a35c1347b5c7afbac1b40be929317aef63b97ca06c6d5a3621140b5a8bf9
BLAKE2b-256 checksum
How to use checksums
e92044fe4059bb7f7c8a1b25c19f680ee6f0e091e3878f89ccc58772ba4999e0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.0

Security for zen-timer 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page