setlist

command module
v0.3.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 30, 2024 License: GPL-3.0 Imports: 1 Imported by: 0

README

Musicians Repertoire and Setlist tool

  • Generates set lists
  • Generates cheat sheets

Status of the Project

This is currently just a PoC. I am using it for my musical hobby and develop it on the go.

Dependencies

  • Cheat sheets can be designed in the odt format. LibreOffice is used to generate pdf.
  • To convert html pdf, a chrome (tested with chromium) browser is required.
Docker image

In case you don't want to install the dependencies locally, you can use the docker image:

Example:

docker run --rm -v $(pwd)/test/Repertoire:/repertoire setlist setlist sheet --band Band --all

Repertoire

By convention the Repertoire is organised in the following directory structure:

The repertoire is partitioned into substructures for example to support multiple bands.

Band
├── Gigs
│   └── 'Grand Ole Opry.md'
├── Songs
│   ├── 'Frankie and Johnnie.odt'
│   ├── 'On the Alamo.pdf'
│   └── README.md
└── Repertoire.md
Repertoire.md

Metadata is maintained in a Markdown GFM table on the top level of the Repertoire.md file. See [example]{test/Repertoire/Band/Repertoire.md).

The Table must have a header row. The only mandatory column is the Title column which is used to refer to the song titles for generating both cheat sheet and set list.

Optional columns are used to generate output.

Column Type Used by command
Title Mandatory list, cheat
Year Optional list
Description Optional list
Gigs

Each gig is maintained in a Markdown file within the Gigs subdirectory. The name of the Markdown file is the name of the gig. Each song title is listed on top level of the Markdown file as an unordered list element.

Songs

Each song is maintained in a .pdf file within the Songs subdirectory. Optionally a .pdf can also be generated out of an Open Document (.odt) file. The filename must the same as the song title within the Gig Markdown file in order to be picked up by the cheat sheet generator.

Documentation

Overview

Copyright © 2024 Christof Laenzlinger <christof@laenzlinger.net>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Directories

Path Synopsis
internal
gig

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL