Skip to main content

A CLI application to help users learn guitar fret positions

Project description

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:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fret_trainer-0.3.0.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fret_trainer-0.3.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file fret_trainer-0.3.0.tar.gz.

File metadata

  • Download URL: fret_trainer-0.3.0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fret_trainer-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b804fdbd446ceb20f1cc1b798c2ddf80be3fb5502046d23870dbe262a3f336e8
MD5 7f3a250c1d47b25be62d20affe6225de
BLAKE2b-256 05bca88af75efd5e8cd74c35b19c982fc35301ebe3ac1672c3c3919033d1ae5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for fret_trainer-0.3.0.tar.gz:

Publisher: release.yml on tsunrise/fret-trainer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fret_trainer-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: fret_trainer-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for fret_trainer-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ecc162bcbf0c0b4c86fdc3e780cb36e50b47f99cc1b46cacfe03754810b717d
MD5 0b3203cba9c257dbd5303a7675864012
BLAKE2b-256 eac678c92bef356cb715af7bf4864eb6001ce3dbdab35ef0b1a8486c9e743362

See more details on using hashes here.

Provenance

The following attestation bundles were made for fret_trainer-0.3.0-py3-none-any.whl:

Publisher: release.yml on tsunrise/fret-trainer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page