64 lines
1.3 KiB
ReStructuredText
64 lines
1.3 KiB
ReStructuredText
igitar
|
|
===============
|
|
|
|
**igitar** *[ee-gee-tahr]* isiXhosa, meaning guitar
|
|
|
|
``igitar`` is a ChordPro parser, written in Python. The main difference between this module
|
|
and other similar libraries is that ``igitar`` parses ChordPro files down to the syllable
|
|
level, enabling finer-grained control of the formatted output.
|
|
|
|
.. warning::
|
|
|
|
This package is still in development. Only a subset of ChordPro is currently supported, and
|
|
some key features are missing, like displaying song metadata.
|
|
|
|
Installation
|
|
------------
|
|
|
|
You can use ``pip`` to install ``igitar``:
|
|
|
|
.. code-block:: shell-session
|
|
|
|
$ pip install igitar
|
|
|
|
Example Usage
|
|
-------------
|
|
|
|
.. code-block:: python
|
|
|
|
from igitar import Song
|
|
|
|
song = Song('path/to/song.chordpro')
|
|
|
|
for verse in song.verses:
|
|
print(verse.title)
|
|
|
|
Rendering
|
|
---------
|
|
|
|
``igitar`` comes with two renders, HTML and Text.
|
|
|
|
.. code-block:: python
|
|
|
|
from igitar.renderers.html import render
|
|
|
|
print(render(song))
|
|
|
|
|
|
Command Line Interface
|
|
----------------------
|
|
|
|
``igitar`` also ships with a built-in command line interface which will read a ChordPro
|
|
file and then render it using either the text or HTML renderer.
|
|
|
|
For example:
|
|
|
|
.. code-block:: shell-session
|
|
|
|
$ igitar path/to/song.chordpro -f text -o song.txt
|
|
|
|
License
|
|
-------
|
|
|
|
``igitar`` is licensed under the MIT license. See the LICENSE file for more information.
|