A music theory library in python named after Charlie Parker
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
parker
references
scripts
tests
.coveragerc
.gitignore
.travis.yml
LICENSE
Makefile
README.md
requirements-dev.txt
requirements.txt
setup.py
tox.ini
update_coveralls.py

README.md

Build Status Coverage Status Documentation Status LGPL License Github Issues Pending Pull-Requests

Parker

This is a library to help me understand music theory and build useful studying tools for my music courses. I am aiming at two things:

  • Ease of use in constructing tools
  • Completion of music theory

Make Commands

There are several commands in the makefile for convenience. You can list them by typing make or make help.

Testing Locally

Easy to test. Simply run make test.

This project uses Tox to test. You will need to have python 2.7 and python 3.5 available to run the tests.

Packaging

Packaging is done with make package.

Linting

Style is important. Check with make lint.

Documentation

Change to the docs directory. Then do the following:

$ cd docs/
$ virtualenv .venv
$ source .venv/bin/activate
(.venv) $ pip install -r requirements.txt
(.venv) $ pip install -r requirements-local.txt --upgrade
(.venv) $ make html
(.venv) $ open build/index.html

It's important that the current version of the library be installed in order to generate the API docs. To insure this insure to install from requirements-local.txt with the --upgrade flag every time. Example:

$ source .venv/bin/activate
(.venv) $ pip install -r requirements-local.txt --upgrade
(.venv) $ make html

Credit

This began as a reconstruction of work from another library so I could get a handle on music theory in python. Credit is due to the original author bspaans:

https://github.com/bspaans/python-mingus/tree/mingus-oo/mingus