Skip to content

Latest commit

 

History

History
46 lines (36 loc) · 2.38 KB

README.md

File metadata and controls

46 lines (36 loc) · 2.38 KB
Raw

songbook-tools

Tools for minimally markuped songs, like LaTeX songbook generation and chord transposition.

Installation

Install dependencies via pip:

pip install -r requirements.txt --user

Contents and Usage

  • examples/ - Directory with minimally markuped song examples.

  • extra-tools/ - Directory with extra tools.

  • song-directory-to-songbook.py - Given a directory composed by minimally markuped songs, generate a pdf songbook via LaTeX. Parameters (all optional, complementary to CLI queries):

    -h, --help           show this help message and exit
--input INPUT        path of the default song input directory (default: "examples/")
--output OUTPUT      name of the output pdf file (default: "Songbook.pdf")
--template TEMPLATE  name of the LaTeX template file [specifies language, etc] (default: "template/english.tex")
--manifest MANIFEST  name of a file-avoiding manifest file [if desired] (default: "")
--yes [YES]          accept all, skip all queries (default: "NULL")

  • song-directory-transpose.py - Given a directory composed by minimally markuped songs, create a new directory with transposed chords (by number of semitones and/or capo/drop removal). Parameters (all optional, complementary to CLI queries):

    -h, --help            show this help message and exit
--input INPUT         path of the default song input directory (default: "examples/")
--output OUTPUT       path of the default song output directory (default: "out/")
--transpose TRANSPOSE half tones of transposition (default: "0")
--capoDropCorrection CAPODROPCORRECTION
                      if automatic capo/drop correction should be applied (default: "yes")
--yes [YES]           accept all, skip all queries (default: "NULL")

Similar and Related