vmf-converter

VMF Converter for music21.

This converter extends music21 to have the capability of reading and writing VMF files.

Setup

This converter is tested under Python 3.4 and requires music21 version 2.0.4 or later.

Creating a virtualenv

It is recommended to use a virtual environment to isolate projects on your filesystem.

From a command prompt, run the following to create your virtualenv:

$ pyvenv-3.4 {venvname}

where {venvname} is the name of your virtualenv.

Activating the virtualenv

The virtualenv that was created can be activated by navigating to the root directory of the virtualenv and running the following:

$ source ./bin/activate

Known issue in Ubuntu 14.04 LTS

On Ubuntu 14.04 LTS, there is a known bug with pre-installing pip into the virtualenv. In this case, use the following:

$ pyvenv-3.4 --without-pip {venvname}

This will install the virtualenv without pip installed. Activate this virtualenv and run the following to install pip and setuptools.

$ wget https://pypi.python.org/packages/source/s/setuptools/setuptools-3.4.4.tar.gz
$ tar -vzxf setuptools-3.4.4.tar.gz
$ cd setuptools-3.4.4
$ python setup.py install
$ cd ..
$ wget https://pypi.python.org/packages/source/p/pip/pip-1.5.6.tar.gz
$ tar -vzxf pip-1.5.6.tar.gz
$ cd pip-1.5.6
$ python setup.py install
$ cd ..
$ rm -rf pip-1.5.6 pip-1.5.6.tar.gz setuptools-3.4.4 setuptools-3.4.4.tar.gz

Now you should have a virtualenv which is ready for population.

Installing project dependencies

With the virtualenv activated, navigate to the project root and run:

$ pip install -r requirements.txt

This will install the dependencies of this project.

Usage

To use this converter, first it must be registered with music21. The following example shows parsing and writing a file.

from music21 import converter
from vmf_converter.vmf_converter import VMFConverter

# Register the converter.
converter.registerSubconverter(VMFConverter)

# Parse a VMF file.
score = converter.parse('/path/to/in/file.vmf')

# Write the score back to file.
score.write('vmf', '/path/to/out/file.vmf')

Because this converter is built on music21, it can parse music21 files into a music21 stream and it can also write a music21 stream back to a vmf file.

API documentation is found at ReadTheDocs

Testing

To run the tests, nosetests is used from the project root:

$ nosetests -w tests

To run the tests and generate a code coverage report:

$ nosetests --with-coverage --cover-html --cover-html-dir=../cover -w tests