Skip to main content

Fretboard is a python library for generating SVG fretboard images and chord charts in Python.

Project description

Fretboard is a python library for generating SVG fretboard images and chord charts in Python.

example.png

Install

pip install fretboard

Usage

Basic Examples

Guitar chord:

chord = fretboard.Chord(positions='xx0232', fingers='---132')
chord.save('svg/D.svg')

Bass chord:

chord = fretboard.BassChord(positions='x221', fingers='-321')
chord.save('svg/bass-E.svg')

Ukulele chord:

chord = fretboard.UkuleleChord(positions='x232', fingers='-132')
chord.save('svg/ukulele-G.svg')

Penatonic scale shape:

fb = fretboard.Fretboard(frets=(5, 8), style={'marker': {'color': 'dodgerblue'}})
fb.add_marker(string=0, fret=5, label='A', color='chocolate')
fb.add_marker(string=1, fret=5, label='D')
fb.add_marker(string=2, fret=5, label='G')
fb.add_marker(string=3, fret=5, label='C')
fb.add_marker(string=4, fret=5, label='E')
fb.add_marker(string=5, fret=5, label='A', color='chocolate')

fb.add_marker(string=0, fret=8, label='C')
fb.add_marker(string=1, fret=7, label='E')
fb.add_marker(string=2, fret=7, label='A', color='chocolate')
fb.add_marker(string=3, fret=7, label='D')
fb.add_marker(string=4, fret=8, label='G')
fb.add_marker(string=5, fret=8, label='C')
fb.save('svg/pentatonic-shape.svg')

Demo

The demo/ directory contains runnable examples that are served up in a web page.

python-fretboard/demo $ pip install -r requirements.txt
python-fretboard/demo $ invoke serve

Point your browser to http://localhost:8080 and check out the freshly rendered fretboards!

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

fretboard-1.0.0.tar.gz (5.7 kB view hashes)

Uploaded Source

Built Distribution

fretboard-1.0.0-py2.py3-none-any.whl (8.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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