karaokemanager 1.0.0

Karaoke session management utility

KaraokeManager

Command-line karaoke session management utility, driving Winamp.

• Maintains a list of singers and their selected songs, key changes, etc.
• Easily add/delete/move singers and songs with short, simple commands. No mouse required.
• Fast undo & redo functionality for fat finger syndrome.
• Singers maintain their position in the queue, even if they currently have no songs cued up.
• Heavy OCD rating.
  • Enforces correctly formatted karaoke and music filenames.
  • Can analyze your library for duplicates, bad capitalization, similar-looking titles, missing "The" prefixes, etc (lists of analysis exemptions can be created).
• Writes the current list of singers to a file for the SingersQueue plugin to display.
• Not just karaoke! There are also commands for adding non-karaoke music tracks to a playlist, for the AutoDJ plugin to play in-between singers.

Installation

Just run 'pip install karaokemanager'.

To run it

• First, install a driver! (see below)
• Copy the YAML template to ".yaml", and modify it with your own settings.
• Then just run py -m karaokemanager
• If you hate the config filename, rename it, and provide it as an argument to the program, e.g. py -m karaokemanager renamed_file.yml

Drivers

This utility was created so that it could work with any karaoke player. For it to "drive" the player, you need to provide it with a driver.

Currently, one driver exists, for Winamp, the 90s music player for Windows. There are currently no drivers for any Linux apps. If you know of a useable Linux karaoke app, I'm all ears.

Anyway, if you want to use the Winamp driver, you should install it first with pip.

• PyPI link
• GitHub link

If you want to create a driver for your favourite karaoke player, create a Python class that exposes two methods:

	def __init__(self, config)
	def play_karaoke_file(self, karaoke_file, key_change, errors)

• config is the pyyaml object that represents the driver-specific section from the KaraokeManager config file.
• karaoke_file is the path to the file that should be played
• key_change is a numeric value that tells you how many semitones the pitch of the track should be shifted.
• errors is a list to which you should append any error messages that KaraokeManager will display to the user.
• The constructor should raise an exception if there is a problem.

Create a package containing this code, install it, and then set the driver->class value in the KaraokeManager config file to point to your class.

TODO

• More customization.
• More code comments.

v1.0

First release