Skip to main content

Fretty is a guitar fretboard generator

Project description

fretty

Fretty is a guitar fretboard generator.

Installation

pip install fretty

Usage

how to run fretty:

fretty example/C-major-scale-box1.ft -o C-major-scale-box1.svg

This will produce the file C-major-scale-box1.svg

Basic Format

III
- - o - o #
- - o o - o
- o # - o -
o - o - o -
# - o - o -
o - o - o -

The first line is the position of the starting fret. Every line which follows is the representation on string.

  • 'o' is a node
  • '#' is a note as square shape
  • '-' is an empty place
  • numbers are displayed as notes
II
-5--
---3
--71
3--5
71--
-5--
  • '|' is for a barre note
  • 'X' is a muted string
III
|---
|o--
|-o-
|-o-
|---
X---
  • '+' is a open string
I
--o-
---o
--o-
+---
X---
X---

Extended Format

You can enclose any text with branches.

  • '(' - ')' for circle notes
  • '[' - ']' for square notes
III
  -    -    (vi)    -   (vii)  [I]
  -    -    (iii)  (IV)   -    (V)
  -  (vii)  [I]     -    (ii)   -
(IV)   -    (V)     -    (vi)   -
[I]    -    (ii)    -    (iii)  -
(V)    -    (vi)    -    (vii)  -

If you close the note by using the barre synbol, instead of the closing branch, the note will be part of a barre symbol.

V
(5|   -   -   -
|    (3)  -   -
(7|   -   -   -
|     -  (5)  -
(1|   -   -   -
X     -   -   -

Additional Information

This project was inspired by svguitar.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

fretty-2.1.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file fretty-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: fretty-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for fretty-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 27966512ba8100763501f19fd07df91019bf6548ddc719f55152d25064434537
MD5 7ac564cab40bf185ecad875cc58e7d86
BLAKE2b-256 ac9b414243d6fe74f4cddb7fca104b3150c0fd2554f716a2d4d9c679a3b40b90

See more details on using hashes here.

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