From 45416a406499aa977b788be65db07b55a9f318a7 Mon Sep 17 00:00:00 2001 From: Raoul Snyman Date: Wed, 28 Jul 2021 19:48:02 -0700 Subject: [PATCH] Reformatted README as reStructuredText --- README.md | 3 --- README.rst | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 3 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 473670e..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# python-chordpro - -A ChordPro parser, written in Python. \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..8fa79f0 --- /dev/null +++ b/README.rst @@ -0,0 +1,52 @@ +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 +------------- + +.. code-block:: python + + 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. + +.. code-block:: python + + 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.