Metadata-Version: 2.4
Name: tui-notes
Version: 0.1.0
Summary: A terminal-based post-it notes application with a 3x3 grid layout
Project-URL: Homepage, https://github.com/Douglas019BR/tui-notes
Project-URL: Repository, https://github.com/Douglas019BR/tui-notes
Author: Douglas
License-Expression: MIT
License-File: LICENSE
Keywords: notes,post-it,terminal,textual,tui
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Requires-Dist: textual>=0.50.0
Provides-Extra: dev
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Requires-Dist: textual-dev>=1.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# TUI Notes 📝

A terminal-based post-it notes application — organize your thoughts in a 3×3 grid, right from the command line.

![Python](https://img.shields.io/badge/Python-3.9%2B-blue)
![License](https://img.shields.io/badge/License-MIT-green)

## Features

- **3×3 Post-it Grid** — Up to 9 notes displayed simultaneously
- **6 Colors** — Yellow, Green, Blue, Pink, Orange, Purple (press `c` to change)
- **Persistent Storage** — Auto-saves to `~/.config/tui-notes/notes.json`
- **Move Mode** — Rearrange notes freely, even to empty slots
- **Export** — Export all notes to Markdown (`Ctrl+E`)
- **Keyboard-driven** — Full operation without mouse

## Installation

```bash
# Clone and install
git clone https://github.com/douglas/tui-notes.git
cd tui-notes
pip install -e .

# Or with pipx (recommended for CLI tools)
pipx install .
```

## Usage

```bash
tui-notes
```

## Keyboard Shortcuts

| Key | Action |
|-----|--------|
| `a` | Add note at selected position |
| `e` / `Enter` | Edit selected note |
| `d` | Delete selected note (with confirmation) |
| `c` | Change note color |
| `m` | Enter Move mode (swap/reorder) |
| `←` `↑` `↓` `→` | Navigate between slots |
| `Ctrl+S` | Save notes manually |
| `Ctrl+R` | Reload notes from disk |
| `Ctrl+E` | Export to `~/tui-notes-export.md` |
| `?` | Show help screen |
| `Escape` | Cancel move mode |
| `q` | Quit |

## Data Storage

Notes are stored as JSON in the platform-specific config directory:

| Platform | Path |
|----------|------|
| Linux | `~/.config/tui-notes/notes.json` |
| macOS | `~/Library/Application Support/tui-notes/notes.json` |
| Windows | `%APPDATA%/tui-notes/notes.json` |

## Development

```bash
# Setup
python -m venv venv
source venv/bin/activate
pip install -e .
pip install -r requirements-dev.txt

# Run
python -m tui_notes

# Tests
pytest

# Linting
black tui_notes/ tests/
isort tui_notes/ tests/
pylint tui_notes/
```

## Requirements

- Python 3.9+
- Terminal with color support

## License

MIT — see [LICENSE](LICENSE) file.
