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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2Python 3

File details

Details for the file fretboard-1.0.0.tar.gz.

File metadata

  • Download URL: fretboard-1.0.0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for fretboard-1.0.0.tar.gz
Algorithm Hash digest
SHA256 bf5bef92db7bb1d7cde2ec435232b2033f0855737776b606506091fe8fe584ee
MD5 2123048563a6ebf4d513caf317b15b0e
BLAKE2b-256 0f62ccd9d2d34e767e62505ec3319f3a3b373087296c24012d4bc15ecdeda576

See more details on using hashes here.

File details

Details for the file fretboard-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fretboard-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1836ee4ad9c709c07c35fe0606584daf643a7388904a0a3a4560c596f3fc74b6
MD5 69816d7c86ee8cbf9d7c1acf0ab888f0
BLAKE2b-256 4787d557cb2018c39e82992e28fda6fc3c94630e100dc8c6356921250eb72531

See more details on using hashes here.

Supported by

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