Hindustani API

compmusic.dunya.hindustani.download_mp3(recordingid, location)

Download the mp3 of a document and save it to the specificed directory.

Parameters

• recordingid – The MBID of the recording

• location – Where to save the mp3 to

compmusic.dunya.hindustani.download_release(release_id, location)

Download the mp3s of all recordings in a release and save them to the specificed directory.

Parameters

• release_id – The MBID of the release

• location – Where to save the mp3s to

compmusic.dunya.hindustani.get_artist(ambid)

Get specific information about an artist.

Parameters

ambid – An artist mbid

Returns

mbid, name, releases, instruments, recordings

releases, instruments and recordings include information from recording- and release-level relationships, as well as release artists

compmusic.dunya.hindustani.get_artists()

Get a list of Hindustani artists in the database. This function will automatically page through API results.

Returns

A list of dictionaries containing artist information:

{"mbid": MusicBrainz artist ID, "name": Name of the artist}

For additional information about each artist use get_artist().

compmusic.dunya.hindustani.get_form(fid)

Get specific information about a form.

Parameters

fid – A form id or uuid

Returns

uuid, name, artists, recordings.

artists includes artists with recording- and release- level relationships to a recording with this form

compmusic.dunya.hindustani.get_forms()

Get a list of Hindustani forms in the database. This function will automatically page through API results.

Returns

A list of dictionaries containing form information:

{"uuid": form uuid, "name": name of the form}

For additional information about each form use get_form()

compmusic.dunya.hindustani.get_instrument(iid)

Get specific information about an instrument.

Parameters

iid – An instrument id

Returns

id, name, artists

artists includes artists with recording- and release- level performance relationships of this instrument.

compmusic.dunya.hindustani.get_instruments()

Get a list of Hindustani instruments in the database. This function will automatically page through API results.

Returns

A list of dictionaries containing instrument information:

{"id": instrument id, "name": Name of the instrument}

For additional information about each instrument use get_instrument()

compmusic.dunya.hindustani.get_laya(lid)

Get specific information about a laya.

Parameters

lid – A laya id or uuid

Returns

id, name, recordings

compmusic.dunya.hindustani.get_layas()

Get a list of Hindustani layas in the database. This function will automatically page through API results.

Returns

A list of dictionaries containing laya information:

{"id": laya id, "name": name of the laya}

For additional information about each laya use get_laya().

compmusic.dunya.hindustani.get_raag(rid)

Get specific information about a raag.

Parameters

rid – A raag id or uuid

Returns

uuid, name, artists, recordings, composers

artists includes artists with recording-level relationships to a recording with this raag

compmusic.dunya.hindustani.get_raags()

Get a list of Hindustani raags in the database. This function will automatically page through API results.

Returns

A list of dictionaries containing raag information:

{"uuid": raag uuid, "name": name of the raag}

For additional information about each raag use get_raag().

compmusic.dunya.hindustani.get_recording(rmbid)

Get specific information about a recording.

Parameters

rmbid – A recording mbid

Returns

mbid, title, artists, raags, taals, layas, forms and works.

artists include performance relationships attached to the recording, the release, and the release artists.

compmusic.dunya.hindustani.get_recordings(recording_detail=False)

Get a list of hindustani recordings in the database. This function will automatically page through API results.

Parameters

recording_detail – if True, return full details for each recording like get_recording()

Returns

A list of dictionaries containing recording information:

{"mbid": MusicBrainz recording ID, "title": Title of the recording}

For additional information about each recording use get_recording().

compmusic.dunya.hindustani.get_release(cmbid)

Get specific information about a release.

Parameters

cmbid – A release mbid

Returns

mbid, title, artists, tracks, release artists

artists includes performance relationships attached to the recordings, the release, and the release artists.

compmusic.dunya.hindustani.get_releases()

Get a list of Hindustani releases in the database. This function will automatically page through API results.

Returns

A list of dictionaries containing release information:

{"mbid": MusicBrainz release ID, "title": title of the release}

For additional information about each release use get_release().

compmusic.dunya.hindustani.get_taal(tid)

Get specific information about a taal.

Parameters

tid – A taal id or uuid

Returns

uuid, name, recordings, composers

compmusic.dunya.hindustani.get_taals()

Get a list of Hindustani taals in the database. This function will automatically page through API results.

Returns

A list of dictionaries containing taal information:

{"uuid": taal uuid, "name": name of the taal}

For additional information about each taal use get_taal().

compmusic.dunya.hindustani.get_work(wmbid)

Get specific information about a work.

Parameters

wmbid – A work mbid

Returns

mbid, title, recordings

compmusic.dunya.hindustani.get_works()

Get a list of Hindustani works in the database. This function will automatically page through API results.

Returns

A list of dictionaries containing work information:

{"mbid": MusicBrainz work ID, "name": work name}

For additional information about each work use get_work().

compmusic.dunya.hindustani.set_collections(collections)

Set a list of collections mbid to restrict the queries. You must call this before you can make any other calls, otherwise they won’t be restricted.

Parameters

collections – list of collections mbids