Skip to main content

Read, write, and manipulate GP3, GP4 and GP5 files.

Project description

Travis-CI Build Status PyPI Package latest release

Introduction

PyGuitarPro is a package to read, write and manipulate GP3, GP4 and GP5 files. Initially PyGuitarPro is a Python port of AlphaTab which is a Haxe port of TuxGuitar.

This package helps you achieve several goals you might find yourself yearning to do in a day-to-day tabber life:

  • transpose a track without messing the fingering.
  • add first string to the track without messing the fingering.
  • map percussion notes to different values.

Reading .gp* files is as easy as:

import guitarpro
curl = guitarpro.parse('Mastodon - Curl of the Burl.gp5')

Writing .gp* files isn’t that hard as well:

guitarpro.write(curl, 'Mastodon - Curl of the Burl 2.gp5')

All objects representing GP entities are hashable and comparable. This gives the great opportunity to apply diff algorithm to tabs, or even diff3 algorithm to merge tablatures.

To anyone wanting to create their the best guitar tablature editor in Python this package will be the good thing to start with.

Examples

Several usage examples are included in the /examples folder. Please feel free to add your own examples, or improve on some of the existing ones, and then submit them via pull request.

To run one of the examples in your local environment, simply:

cd pyguitarpro
python examples/transpose.py --help

Installation

Install PyGuitarPro from PyPI:

pip install PyGuitarPro

To install development version of PyGuitarPro:

git clone https://github.com/Perlence/PyGuitarPro.git
cd pyguitarpro
pip install -e .

Documentation

Package documentation is located at Read the Docs.

Licensing

Please see the file called LICENSE.

Download files

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

Files for PyGuitarPro, version 0.6
Filename, size File type Python version Upload date Hashes
Filename, size PyGuitarPro-0.6-py2.py3-none-any.whl (89.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size PyGuitarPro-0.6.tar.gz (84.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page