pompy-timer 0.1.1

A terminal-based Pomodoro timer

pompy

Pomodoro timer for your terminal to help you focus, written in Python using curses.

Installation

For end users

The recommended install path for a finished command-line app is PyPI plus pipx. Once the project is published, install it like this:

pipx install pompy-timer

This installs the distribution named pompy-timer, while the command stays pompy and the Python import package stays pompy.

If you want to install directly from a local clone:

pipx install .

For development

Use an editable install so code changes are picked up immediately without reinstalling:

python -m pip install -e .

After that, just rerun pompy in the same environment. You only need to reinstall when you change package metadata, dependencies, or packaging files.

Prerequisites

• Python 3.8+
• pipx if you want the end-user install path above

Usage

pompy [minutes] [label]
pompy [-m MINUTES] [-l LABEL]

Examples:

pompy
pompy 15 focus
pompy --minutes 50 --label deep work

Development loop

When you are iterating on the code, keep the editable install active and run the script again after each change:

python -m pip install -e .
pompy

That is the fastest way to test new changes locally.

Release

Releases are published from GitHub Actions using PyPI trusted publishing.

1. Create and push a version tag, for example v0.1.1.
2. Or trigger the workflow manually from the Actions tab.
3. Configure the PyPI project to trust this GitHub repository for publishing.

Use the PyPI project name pompy-timer when configuring trusted publishing.

The workflow builds both the source distribution and wheel before publishing.

Controls

• space — pause / resume
• q — quit