https://github.com/perlence/pyguitarpro
Read, write and manipulate GP3, GP4 and GP5 files.
https://github.com/perlence/pyguitarpro
guitar-pro python python-3
Last synced: 11 months ago
JSON representation
Read, write and manipulate GP3, GP4 and GP5 files.
- Host: GitHub
- URL: https://github.com/perlence/pyguitarpro
- Owner: Perlence
- License: lgpl-3.0
- Created: 2015-09-28T20:07:19.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-06T08:04:44.000Z (over 2 years ago)
- Last Synced: 2025-04-04T14:02:27.856Z (11 months ago)
- Topics: guitar-pro, python, python-3
- Language: Python
- Homepage: https://pyguitarpro.readthedocs.io
- Size: 3.47 MB
- Stars: 303
- Watchers: 14
- Forks: 44
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
PyGuitarPro
===========
.. image:: https://img.shields.io/pypi/v/pyguitarpro.svg?style=flat
:alt: PyPI Package latest release
:target: https://pypi.org/project/PyGuitarPro/
Introduction
------------
PyGuitarPro is a package to read, write and manipulate GP3, GP4 and GP5 files. Initially PyGuitarPro is a Python port
of `AlphaTab `_ which originally was 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:
.. code-block:: python
import guitarpro
curl = guitarpro.parse('Mastodon - Curl of the Burl.gp5')
Writing ``.gp*`` files isn't that hard as well:
.. code-block:: python
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:
.. code-block:: sh
cd pyguitarpro
python examples/transpose.py --help
Installation
------------
Install PyGuitarPro from PyPI:
.. code-block:: sh
pip install PyGuitarPro
To install development version of PyGuitarPro:
.. code-block:: sh
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``.
.. vim: tw=120 cc=121