Skip to main content

PyGuitar generates an easy-to-practice chord book.

Project description

PyGuitar: Chord book generator

PyGuitar

PyPI version GitHub version license

PyGuitar generates an easy-to-practice chord book.

Installation

There are two ways to install PyGuitar:

  • Install PyGuitar from PyPI (recommended):
    $ sudo pip install PyGuitar
    
  • Alternatively: install PyGuitar from the GitHub source:
    $ git clone https://github.com/iwasakishuto/PyGuitar.git
    $ cd PyGuitar
    $ sudo python setup.py install
    

How to use

  • Create Guitar Instance
    from guitar import Guitar
    guitar = Guitar(key="C", scale="major")
    
  • plot guitar layout
    guitar.plot_chord_layout()
    
    Output chord layout
  • plot guitar strings
    guitar.plot_strings()
    
    Output guitar strings
  • plot chord
    guitar.plot_chord(chode="G#", string=6, mode="minor")
    
    Output chord-G#.png
  • export chordbook
    guitar = Guitar(key="B", scale="major", dark_mode=False)
    guitar.set_chord(chode="D#", string=5, mode="minor")
    guitar.set_chord(chode="G#", string=6, mode="minor")
    guitar.set_chord(chode="E",  string=6, mode="major")
    guitar.set_chord(chode="B",  string=5, mode="major")
    guitar.set_chord(chode="F#", string=6, mode="minor")
    guitar.set_chord(chode="C#", string=5, mode="major")
    guitar.set_chord(chode="F#", string=6, mode="sus4")
    guitar.set_chord(chode="C#", string=5, mode="7th")
    guitar.set_chord(chode="D#", string=5, mode="7th")
    guitar.export_chord_book(fmt="pdf")
    
    Output Whole-notes.png
  • scraping -> chordbook
    title, key, data = get_ufret_chords_with_driver(url)
    guitar = Guitar()
    guitar.create_chord_book(data)
    
    Output chordbook.png
  • scraping -> chordbook (docker oneline)
    pwd
    path/to/PyGuitar/docker
    make ufret URL="https://www.ufret.jp/song.php?data=5012"
    :
    Save data at /data/'欲望に満ちた青年団 | ONE OK ROCK'-key_B-major_scale.pdf
    

Reference

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for PyGuitar, version 0.3.7
Filename, size File type Python version Upload date Hashes
Filename, size PyGuitar-0.3.7.tar.gz (4.5 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page