raoul
/
igitar
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
A ChordPro parser, written in Python. https://igitar.com
9 Commits 1 Branch 2 Tags 115 KiB
Python 100%
Go to file
Raoul Snyman 1834e17c56 Add setuptools data for building a package 2021-07-28 21:39:43 -07:00
src/chordpro Various updates, including a new text renderer 2021-07-28 11:41:15 -07:00
.gitignore Add ignore file 2021-07-23 21:46:12 -07:00
LICENSE Initial commit 2021-07-24 06:33:16 +00:00
README.rst Reformatted README as reStructuredText 2021-07-28 19:48:02 -07:00
pyproject.toml Add setuptools data for building a package 2021-07-28 21:39:43 -07:00
setup.cfg Add setuptools data for building a package 2021-07-28 21:39:43 -07:00
setup.py Add setuptools data for building a package 2021-07-28 21:39:43 -07:00

README.rst

python-chordpro

python-chordpro is a ChordPro parser, written in Python. The main difference between this module and other similar libraries is that python-chordpro parses ChordPro files down to the syllable level, enabling finer-grained control of the formatted output.

Installation

You can use pip to install python-chordpro:

$ pip install python-chordpro

Example Usage

from chordpro import Song

song = Song('path/to/song.chordpro')

for verse in song.verses:
    print(verse.title)

Rendering

python-chordpro comes with two renders, HTML and Text.

from chordpro.renderers.html import render

print(render(song))

Command Line Interface

python-chordpro 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:

$ python-chordpro path/to/song.chordpro -f text -o song.txt

License

python-chordpro is licensed under the MIT license. See the LICENSE file for more information.