Setting up your Development Environment - Godley/Music-Library GitHub Wiki

All Platforms

Contact the lovely developers at MuseScore and request an API key. Set an environment variable called MSCORE and put the key as the value.

On Mac

To install all the requirements I recommend MacPorts. You may use home-brew, but I recommend macports because they have a recipe which encapsulates the 2 hardest package dependencies: pyqt4 and poppler. Future devs may want to write instructions for home-brew.

Before going down either route, you will need to install Xcode from the App store and accept the license. You will probably need to install CLI tools using a specific command which I don't remember off the top of my head.

On MacPorts

  1. Install MacPorts.

  2. Run sudo port install py34-pip followed by sudo port select --set python3 python34 to get python and use the mac ports version rather than the default mac version. Then run sudo port select --set pip3 pip34 which sets pip34 as your default pip3 package manager.

  3. sudo port install py34-poppler-qt4: this should fetch qt4, python qt4, poppler, poppler-qt4 bindings and finally, python poppler qt4 which allows you to create guis from python and use poppler, a pdf rendering library with qt and python.

  4. sudo port edit py34-cx_freeze: update the cx_freeze version to >= 4.4.3 - 4.4.1 contains a bug. This will also require updating the checksum. You can do this by saving it, running sudo port install py34-cx_freeze, checking the log and updating the py34-cx_freeze file with those checksums. Finally, run this again.

After all that...

  1. Clone this repo, navigate to the repo directory and run pip install -r requirements.txt.

On Linux

Linux is basically all apt-get based. Fetch python3-qt4, python-qt4-dev, python3-sip, python3-sip-dev, libpoppler-qt4-4, libpoppler-qt4-dev from apt-get as well as pip if you don't already have it, then pip3 install python-poppler-qt4. Requests will probably already be in your site packages. Also run pip3 install MuseParse which is our musicXML renderer.

On Windows

  1. Install Python 3.4.3.

  2. From Riverbank Computing, navigate to Binary Packages and download the pyqt4 installer and run it.

  3. Download and install Lilypond.

  4. Clone this repo, navigate to the home folder and run pip3 install -r requirements.txt