Tool to build EPUB songbooks from lists of ChordPro files
Project description
chordpro-epub
Simple script to create a songbook from a list of chordpro files.
Installing
Download the latest wheel from the build artifacts, or install with pip
$ pip install git+https://github.com/paulfd/chordpro-epub.git
PyPI availability might come later.
Usage
[user@foo chopro-epub]$ chopro-epub --help
Usage: chopro-epub [OPTIONS] SONG_LIST
Generate an EPUB songbook from a list of songs.
Arguments:
SONG_LIST The path to the file containing the list of songs with one song
per line. [required]
Options:
--output PATH The output path for the generated EPUB
songbook. [default: songbook.epub]
--css PATH The path to a custom CSS file to style the
EPUB.
--book-title TEXT The title of the generated EPUB songbook.
[default: Songbook]
--book-id TEXT An identifier for the EPUB songbook.
[default: songbook31415926535]
--book-author TEXT The author or creator of the EPUB songbook.
--wrap-chords / --no-wrap-chords
If True, chords within the song lyrics will
be wrapped in square brackets. [default:
no-wrap-chords]
--verbose / --no-verbose [default: no-verbose]
--help Show this message and exit.
Example usage
$ chopro-epub list.txt --verbose
$ chopro-epub --css custom.css --book-author "Paul Ferrand" --book-title "My Songbook" list.txt
Custom styling
You can use the default style as a basis to customize the output style.
Contributing
The project is fairly contained. I added pre-commit hooks that you
can use by running pre-commit install
in this repository. Any contribution is welcome.
Note that I do not wish to host songs here.
Acknowledgements
Thanks a lot to Robert Hoeller for the much improved parsing code!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
chopro_epub-1.1.1.tar.gz
(8.4 kB
view hashes)
Built Distribution
Close
Hashes for chopro_epub-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9209bf7550415e3742c446b226e9dfd4aebdcc32ffbb8087a085905a6ab40afe |
|
MD5 | 6a3f62bf97be0fb12b6d0fc9614ade88 |
|
BLAKE2b-256 | 9552a613d557eea7d410a26f416bd83fcfbb5d60af4b6a80c197a5c722512683 |