Metadata-Version: 2.4
Name: hyprtodo
Version: 0.1.1
Summary: A todo list widget for Hyprland
Project-URL: Homepage, https://github.com/williamj48/hyprtodo
Project-URL: Repository, https://github.com/williamj48/hyprtodo
Author-email: William Elder <williamxelder@gmail.com>
License: MIT
License-File: LICENSE
Requires-Python: >=3.8
Requires-Dist: pyqt6
Requires-Dist: textual
Description-Content-Type: text/markdown

# hyprtodo

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI version](https://badge.fury.io/py/hyprtodo.svg)](https://badge.fury.io/py/hyprtodo)

**System tray integration** - Quick access from your system tray
 **Vim-like keybindings** - Navigate with j/k
**Customizable theme** - Edit CSS to match your desktop
**Simple and fast** - Lightweight TUI interface

## Installation

### Linux

**Using pipx (recommended):**
```bash
pipx install hyprtodo
```

**Using pip:**
```bash
pip install hyprtodo
```

### Windows
System Tray integration is not supported with windows. Only running the application

**Clone the repository:**
```bash
git clone https://github.com/williamj48/hyprtodo.git
cd hyprtodo
python3 hyprtodo
```




## Usage

Simply run:
```bash
hyprtodo
```

This will create a system tray icon. Click the icon to open your todo list in a terminal window.

**Keybindings:**
- `j` / `k` - Move down/up
- `Enter` - Add new todo
- `Space` - Toggle selection
- `Ctrl+C` / `q` - Quit
- `Esc` - Unfocus input

Click the "Commit" button or press Enter in the input field to save changes.

## Configuration

### Todo Storage
Your todos are stored at:
```
~/.config/hypr/hyprtodo/todo.txt
```

Do not edit this file. It is meant to only be accessed through the application

### Custom Styling
The CSS theme file is automatically created at:
```
~/.config/hyprtodo/custom.tcss
```

Edit this file to customize colors, borders, and styling to match your desktop theme.

### Terminal Configuration
By default, hyprtodo uses `kitty` as the terminal. To use a different terminal, set the `TERMINAL` environment variable:

```bash
export TERMINAL=alacritty
hyprtodo
```

## Requirements

- Python 3.8+
- Linux with system tray support

## Future Plans

- 🔄 Google Tasks API integration for cloud sync
- 📱 Additional export formats
- 🔔 Desktop notifications for reminders

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Author

William Elder - [williamxelder@gmail.com](mailto:williamxelder@gmail.com)

## Repository

[https://github.com/williamj48/hyprtodo
