Skip to main content

python-fretboard

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!

Metadata

Release files for fretboard 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fretboard 1.0.0
File Size Uploaded Provenance Actions
fretboard-1.0.0.tar.gz 5.7 kB Without provenance Details for fretboard-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fretboard 1.0.0
File Interpreter ABI Platform Actions
fretboard-1.0.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for fretboard-1.0.0-py2.py3-none-any.whl

Total release size: 14.0 kB

Release files / fretboard-1.0.0.tar.gz

Download URL fretboard-1.0.0.tar.gz
Size 5.7 kB
Tags Source
SHA-256 checksum
How to use checksums
bf5bef92db7bb1d7cde2ec435232b2033f0855737776b606506091fe8fe584ee
BLAKE2b-256 checksum
How to use checksums
0f62ccd9d2d34e767e62505ec3319f3a3b373087296c24012d4bc15ecdeda576
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / fretboard-1.0.0-py2.py3-none-any.whl

Download URL fretboard-1.0.0-py2.py3-none-any.whl
Size 8.3 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
1836ee4ad9c709c07c35fe0606584daf643a7388904a0a3a4560c596f3fc74b6
BLAKE2b-256 checksum
How to use checksums
4787d557cb2018c39e82992e28fda6fc3c94630e100dc8c6356921250eb72531
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for fretboard 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page