# 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
<img src="https://raw.githubusercontent.com/thomasvolk/fretty/master/example/C-major-scale-box1.svg" width="200">
* numbers are displayed as notes
```
II
-5--
---3
--71
3--5
71--
-5--
```
<img src="https://raw.githubusercontent.com/thomasvolk/fretty/master/example/C-major-arpeggio.svg" width="200">
* '|' is for a barre note
* 'X' is a muted string
```
III
|---
|o--
|-o-
|-o-
|---
X---
```
<img src="https://raw.githubusercontent.com/thomasvolk/fretty/master/example/Cm-chord.svg" width="200">
* '+' is a open string
```
I
--o-
---o
--o-
+---
X---
X---
```
<img src="https://raw.githubusercontent.com/thomasvolk/fretty/master/example/D-chord.svg" width="200">
## 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) -
```
<img src="https://raw.githubusercontent.com/thomasvolk/fretty/master/example/C-major.svg" width="200">
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 - - -
```
<img src="https://raw.githubusercontent.com/thomasvolk/fretty/master/example/Dm7-chord.svg" width="200">
## Additional Information
This project was inspired by
[svguitar](https://github.com/omnibrain/svguitar).
Raw data
{
"_id": null,
"home_page": "https://github.com/thomasvolk/fretty",
"name": "fretty",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": "",
"keywords": "",
"author": "Thomas Volk",
"author_email": "info@thomasvolk.de",
"download_url": "",
"platform": "any",
"description": "# fretty\n\nFretty is a guitar fretboard generator.\n\n\n## Installation\n\n pip install fretty\n\n## Usage\n\nhow to run fretty:\n\n fretty example/C-major-scale-box1.ft -o C-major-scale-box1.svg\n\nThis will produce the file C-major-scale-box1.svg\n\n## Basic Format\n\n```\nIII\n- - o - o #\n- - o o - o\n- o # - o -\no - o - o -\n# - o - o -\no - o - o -\n```\n\nThe first line is the position of the starting fret.\nEvery line which follows is the representation on string.\n\n* 'o' is a node\n* '#' is a note as square shape\n* '-' is an empty place\n\n<img src=\"https://raw.githubusercontent.com/thomasvolk/fretty/master/example/C-major-scale-box1.svg\" width=\"200\">\n\n* numbers are displayed as notes\n\n```\nII\n-5--\n---3\n--71\n3--5\n71--\n-5--\n```\n\n<img src=\"https://raw.githubusercontent.com/thomasvolk/fretty/master/example/C-major-arpeggio.svg\" width=\"200\">\n\n* '|' is for a barre note\n* 'X' is a muted string\n\n```\nIII\n|---\n|o--\n|-o-\n|-o-\n|---\nX---\n```\n\n<img src=\"https://raw.githubusercontent.com/thomasvolk/fretty/master/example/Cm-chord.svg\" width=\"200\">\n\n* '+' is a open string\n\n```\nI\n--o-\n---o\n--o-\n+---\nX---\nX---\n```\n\n<img src=\"https://raw.githubusercontent.com/thomasvolk/fretty/master/example/D-chord.svg\" width=\"200\">\n\n## Extended Format\n\nYou can enclose any text with branches.\n* '(' - ')' for circle notes\n* '[' - ']' for square notes\n\n```\nIII\n - - (vi) - (vii) [I]\n - - (iii) (IV) - (V)\n - (vii) [I] - (ii) -\n(IV) - (V) - (vi) -\n[I] - (ii) - (iii) -\n(V) - (vi) - (vii) -\n```\n\n<img src=\"https://raw.githubusercontent.com/thomasvolk/fretty/master/example/C-major.svg\" width=\"200\">\n\nIf you close the note by using the barre synbol, instead of the closing branch,\nthe note will be part of a barre symbol.\n\n```\nV\n(5| - - -\n| (3) - -\n(7| - - -\n| - (5) -\n(1| - - -\nX - - -\n```\n\n<img src=\"https://raw.githubusercontent.com/thomasvolk/fretty/master/example/Dm7-chord.svg\" width=\"200\">\n\n\n## Additional Information\n\nThis project was inspired by \n[svguitar](https://github.com/omnibrain/svguitar).\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "Fretty is a guitar fretboard generator",
"version": "2.0.1",
"project_urls": {
"Homepage": "https://github.com/thomasvolk/fretty"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a48d4d87568a166cd370f6d139c14539e06392c8503658e55bbc616c8090777",
"md5": "eb8bb332f6933751f396b88c51c369d2",
"sha256": "bc6a6a6f88c46850cdf9d8385417d81b6d2880a1f3cfda3f87a3fda21f929790"
},
"downloads": -1,
"filename": "fretty-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb8bb332f6933751f396b88c51c369d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 9687,
"upload_time": "2024-02-12T10:01:26",
"upload_time_iso_8601": "2024-02-12T10:01:26.269039Z",
"url": "https://files.pythonhosted.org/packages/3a/48/d4d87568a166cd370f6d139c14539e06392c8503658e55bbc616c8090777/fretty-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-12 10:01:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thomasvolk",
"github_project": "fretty",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "fretty"
}
JSON
