Metadata-Version: 2.4
Name: pompy-timer
Version: 0.1.0
Summary: A terminal-based Pomodoro timer
Author: Sarath Madhav
License: MIT License
        
        Copyright (c) 2026 Sarath Madhav
        
        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.
        
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console :: Curses
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# 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:

```bash
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:

```bash
pipx install .
```

### For development

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

```bash
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
```bash
pompy [minutes] [label]
pompy [-m MINUTES] [-l LABEL]
```

Examples:

```bash
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:

```bash
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

