GitXplorerGitXplorer
m

musixmatch

public
13 stars
3 forks
2 issues

Commits

List of commits on branch master.
Unverified
19a076594182c89a0fe42ece63b890c339d980d9

typos fixed

mmonkeython committed 13 years ago
Unverified
fa04f51251c51499fcf1d52ef10effa038f24199

link fixed

mmonkeython committed 13 years ago
Unverified
48b5b2962a3fff5256f8c009d8e95f11cf52650a

paths fixed

mmonkeython committed 13 years ago
Unverified
e77cec35f59a495895f5fe1bee51458cf1aaaba4

no more apikey tests

mmonkeython committed 13 years ago
Unverified
596e8e44e17a1f68c0279d65dd7fe6088f88ee66

doctest fix

mmonkeython committed 13 years ago
Unverified
22a7a7e82cf32078d6dec627e9ea3bd04107fe2c

docs and build fixing

mmonkeython committed 13 years ago

README

The README file for this repository.

Quick start

  1. First thing first, read the documentation at http://developer.musixmatch.com .
  2. Get an api key by signing up at http://developer.musixmatch.com/mmplans .
  3. Install the musixmatch package
  4. Run the python prompt

import musixmatch apikey = '' try: ... chart = musixmatch.ws.track.chart.get(country='it', apikey=apikey) ... except musixmatch.api.Error, e: ... pass

It's that simple. Last, you can brows this documentation and have fun with the other modules.

Building / Installing

You can just use setup.py to build and install python-musixmatch::

prompt $ python setup.py bdist_egg

Once built, you can use easy_install on the python egg.

Documentation

You can read documentation online_, or generate your own local copy using Sphinx_ trough the setup.py::

prompt $ python setup.py build_sphinx

.. _Sphinx: http://sphinx.pocoo.org .. _online: http://projects.monkeython.com/musixmatch/python-musixmatch/html/index.html

Unit testing

python-musixmatch comes with some essential unit testing. If you set up musixmatch_apikey environment variable, and have internet connection, you can also run some tests on API calls::

prompt $ python setup.py test

Caching support

Applications using python-musixmatch may take advantage of standard urllib support for http_proxy, so they can just set up the proper environment variable:

http_proxy the complete HTTP proxy URL to use in queries.

Considering all the available HTTP proxy solutions, I'm reluctant to implement a further caching support. Though i can consider serialization support.

Environment variables

python-musixmatch takes advantage of operating system environment to get apikey, format and api version values to use in API calls:

musixmatch_apikey the apikey value to use in query strings musixmatch_format the response message format. For example: json musixmatch_wslocation the webservice base url. For example: http://api.musixmatch.com/ws/1.1 musixmatch_apiversion the api version to use in queryes. For example: 1.1. Use of musixmatch_apiversion was deprecated in favour of musixmatch_wslocation.