Metadata-Version: 2.4
Name: fret-trainer
Version: 0.3.0
Summary: A CLI application to help users learn guitar fret positions
License-Expression: MIT
Project-URL: Homepage, https://github.com/tsunrise/fret-trainer
Project-URL: Repository, https://github.com/tsunrise/fret-trainer
Classifier: Programming Language :: Python :: 3
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
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Topic :: Education
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: colorama>=0.4.6

# Guitar Fret Trainer 🎸

A simple CLI tool for help you memorize guitar fret positions. 

I'm using it for my daily exercises and find it useful. 

## Requirements

- Python 3.8 or higher
- colorama

## Installation

Install from PyPI:

```bash
pip install fret-trainer
```

Or install from source:

```bash
pip install -e .
```

## Build

To build the package locally:

```bash
pip install build
python -m build
```

This will create distribution files in the `dist/` directory.

## Release

To create a new release (bumps minor version):

```bash
python release.py
git push && git push --tags
```

This will:
1. Bump the minor version in `pyproject.toml` (e.g., 0.1.0 → 0.2.0)
2. Create a git commit with the version change
3. Create a git tag (e.g., `v0.2.0`)

The GitHub Actions workflow will automatically publish to PyPI when the tag is pushed.

## Usage

Run the trainer:

```bash
fret-trainer
```

Or run directly:

```bash
python fret.py
```

### Controls

- **Z** - Note to Fret Exercise: Displays a randomly sorted string of seven notes (CDEFGAB)
- **X** - Fret to Note Exercise: Shows random fret positions on all six strings
- **Space** - Generate a new exercise of the same type
- **B** or **Left Arrow** - Go back in exercise history
- **N** or **Right Arrow** - Go forward in exercise history
- **Ctrl+C** - Exit the application
