Skip to content

tsunrise/fret-trainer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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
  • Linux or MacOS (The tool requires termios at this time, which is not supported by Windows).

Installation

Install from PyPI:

pip install fret-trainer

Or install from source:

pip install -e .

Build

To build the package locally:

pip install build
python -m build

This will create distribution files in the dist/ directory.

Release

To create a new release (bumps minor version):

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:

fret-trainer

Or run directly:

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

About

🎸CLI Tool for Memorizing Guitar Fret Positions

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages