antscloud / fretboardgtr Public

Notifications You must be signed in to change notification settings
Fork 17
Star 115

Python package for creating fretboard and chord diagram image in svg format

115 stars 17 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 85 Commits
.github		.github
docs		docs
fretboardgtr		fretboardgtr
tests		tests
.bumpversion.cfg		.bumpversion.cfg
.coveragerc		.coveragerc
.editorconfig		.editorconfig
.flake8		.flake8
.gitattributes		.gitattributes
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.pydocstyle.ini		.pydocstyle.ini
.readthedocs.yaml		.readthedocs.yaml
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
README.md		README.md
py.typed		py.typed
pyproject.toml		pyproject.toml
pytest.ini		pytest.ini
setup.py		setup.py

Repository files navigation

FretBoardGtr

Package that make easy creation of highly customizable fretboards and chords diagrams

License: GNU Affero General Public License v3.0
Documentation: https://fretboardgtr.readthedocs.io/en/latest.

Get started

To get started simply install the package from PyPI

Dependencies

fretboardgtr needs to have the following install in order to run :

sudo apt install libcairo2-dev pkg-config

How to install

pip install fretboardgtr

Usage

from fretboardgtr.fretboard import FretBoard
from fretboardgtr.notes_creators import ScaleFromName

fretboard = FretBoard()
c_major = ScaleFromName(root="C", mode="Ionian").get()
fretboard.add_notes(scale=c_major)
fretboard.export("my_fretboard.svg", format="svg")