Skip to main content

Guitar-scales for any key and tuning

Project description

shredder-scales

shredder-scales is a python package that allows look-up of guitar scales given a key, scale, and tuning and outputs a plot showing the valid note positions on the fretboard.

The program accepts any number of guitar strings and any tuning without restriction to standard tunings. The number of guitar strings will be set based on the entered tuning.

For example:

  • 'EADGBE' will set standard 6-string tuning
  • 'G#D#G#C#F#A#D#' will set drop G# 7-string tuning
  • 'F#BEADGBE' will set standard 8-string tuning

Installation

Use the package manager pip for installation

pip install shredderscales

Options

required:
--scale: scale to use for retrieiving notes, ex:'major'
--key: key to use for choosing notes, ex:'C'

optional:
--tuning: tuning of guitar for plotting notes, ex:'EADGBE'
--flats: whether to use sharps or flats for accidentals
--fretnumber: number of frets to plot, max==24 
--mode: mode to display notes on scale['note', 'degree', 'interval']
	- note will display the note at each position: 'C', 'Eb', ect.
	- degree will display degree in that scale: '1', 'b2', '#4', ect.
	- interval will display the distance from root note: 'M2', 'P5', 'm6'
--outdir: directory for saving output plot if run locally
--django: set to '1' for outputing figure as html

Usage

example command line usage:

shredder-scales --scale='major' --key='F' --tuning='CGCFAD' --outdir='/path/to/outdir'

to print out all available scales:

shredder-scales-available

example python usage"

from shredderscales import shredder

shredder.main(scale='minor', key='G', tuning='BEADGBE')

Contributing

Pull requests and issues are welcome!

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

shredderscales-1.0.3.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shredderscales-1.0.3-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file shredderscales-1.0.3.tar.gz.

File metadata

  • Download URL: shredderscales-1.0.3.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for shredderscales-1.0.3.tar.gz
Algorithm Hash digest
SHA256 d845828127cd22baf5b5ad71f55ec041a63e7038b2fad161d131987101cfc159
MD5 0b011ca226eba5301fdb6ed7a8a4039b
BLAKE2b-256 db42062f9b5f52f898d78662b03bdb95a5259341424c6aa4d911e7ab0678f6d1

See more details on using hashes here.

File details

Details for the file shredderscales-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: shredderscales-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for shredderscales-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 333578fb3f5016097d80e6ef215eda1ad349cceb84bc18ccc304c8e01137d2e4
MD5 67408c0ee8ff5b91fce221198bd3b47f
BLAKE2b-256 a18f38a42ae7a635ea979c7752eb313b2d0ac990c70adb7040e2ceef95c63a91

See more details on using hashes here.

Supported by

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