Metadata-Version: 2.1
Name: pucoti
Version: 0.6.0
Summary: A Purposeful Countdown Timer
Home-page: https://github.com/ddorn/pucoti
License: GPL-3.0
Keywords: timer,countdown,pygame
Author: ddorn
Author-email: diego.dorn@free.fr
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: pygame-ce (>=2.4.1,<3.0.0)
Requires-Dist: typer (>=0.12.3,<0.13.0)
Project-URL: Repository, https://github.com/ddorn/pucoti
Description-Content-Type: text/markdown

# PUCOTI

**A Purposeful Countdown Timer**

Stay on task with PUCOTI, a countdown timer built for simplicity and purpose.

### Features:
- **Countdown**: Counts down to zero (and can go below zero).
- **Bell Alert**: Rings a bell when it hits zero.
- **Persistent Reminder**: Rings every 20 seconds until you acknowledge it. Don't forget to do the thing.
- **Set Intentions**: Write down what you intend to do during the countdown.
- **History**: Keeps a log of your intentions and how long you spent on each.
- **Large Font**: Uses the biggest font it can for visibility.
- **Sway Integration**: Automatically moves to the corner of your screen if you use Sway WM.
- **Total Time**: Shows the total time you've spent on the timer.
- **Configurable**: Change the bell sound, waste time changing colors, and more.
- **Basic Controls**: Add or subtract time, reset the timer, but not more.

PUCOTI is straightforward and gets the job done. Give it a try.

## Screenshots

### *Pucoti can be big...*
![Screenshot of PUCOTI full-screen](./assets/screenshot.webp)
### *... or stay in a corner*
![Screenshot of PUCOTI in the bottom right of a screen](./assets/screenshot-small.webp)
### *Keep track of your intentions*
![Screenshot of PUCOTI showing the history of intentions](./assets/screenshot-history.webp)

## Installation

You can easily install PUCOTI using pip. Follow these steps:

1. **Install PUCOTI:**
   ```sh
   pip install pucoti
   ```

2. **Run PUCOTI:**
   ```sh
   pucoti 5m
   ```

That's it! PUCOTI should now be up and running.

## Usage

![Usage](./assets/cli-help.webp)

