python-blobopera icon indicating copy to clipboard operation
python-blobopera copied to clipboard

Toolkit to convert MusicXML files into Blob Opera scores with real lyrics.

Blob Opera Toolkit

test package license Code style: black

Description

Unofficial toolkit to convert MusicXML files into Blob Opera scores with real lyrics, loosely inspired by OverlappingElvis/blob-opera-midi.

Documentation

Samples

:book:  Want to contribute a new sample? Click here!

Usage

  1. Create a score file: Use MuseScore or similar to create a four-part score (soprano, alto, tenor and bass) with a single line of lyrics and export it to MusicXML. You can download MusicXML files from MuseScore by using this tool.

  2. Install the tool:

    pip install blobopera
    
  3. Convert the score file:

    blobopera recording import input.musicxml output.binary
    

    (Take a look at the command-line options)

  4. Upload the recording:

    blobopera recording upload output.binary
    
  5. Visit the generated link with your browser.

Roadmap

  • [X] Publish the package
  • [ ] Add language-specific phoneme translators
  • [ ] Improve the phoneme relocation logic
  • [ ] Write granular unit tests
  • [ ] Extend the documentation

Contributing

  1. Clone this repository:

    $ git clone https://github.com/0x2b3bfa0/python-blobopera
    $ cd python-blobopera
    
  2. Install the dependencies with poetry:

    $ poetry install
    
  3. Run the command-line tool:

    $ poetry run blobopera
    
  4. Run the module tests:

    $ poetry run poe all