Andalusian API¶
-
compmusic.dunya.andalusian.
download_lyrics
(recordingid, location)[source]¶ Download the arabic and transliteration version of the lyrics of a specific recording
- Parameters
recordingid – The MBID of the recording
location – Where to save the json to
-
compmusic.dunya.andalusian.
download_mp3
(recordingid, location)[source]¶ Download the mp3 of a document and save it to the specified directory.
- Parameters
recordingid – The MBID of the recording
location – Where to save the mp3 to
-
compmusic.dunya.andalusian.
download_pitch_distribution
(recordingid, location)[source]¶ Download the pitch distribution from a specific recording and save it to the specified directory.
- Parameters
recordingid – The MBID of the recording
location – Where to save the json to
-
compmusic.dunya.andalusian.
download_pitch_track
(recordingid, location)[source]¶ Download the pitch track from a specific recording and save it to the specified directory.
- Parameters
recordingid – The MBID of the recording
location – Where to save the json to
-
compmusic.dunya.andalusian.
download_score
(recordingid, location)[source]¶ Download the score of a document and save it to the specified directory.
- Parameters
recordingid – The MBID of the recording
location – Where to save the score file to
-
compmusic.dunya.andalusian.
get_artist
(ambid)[source]¶ Get specific information about an artist.
- Parameters
ambid – An artist mbid
- Returns
mbid, name, releases, instruments, recordings.
releases
,instruments
andrecordings
include information from recording- and release-level relationships, as well as release artists
-
compmusic.dunya.andalusian.
get_artists
()[source]¶ Get a list of Andalusian 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}
-
compmusic.dunya.andalusian.
get_form
(fid)[source]¶ Get specific information about a form.
- Parameters
fid – A form mbid
- Returns
uuid, name, transliterated_name, display_order
-
compmusic.dunya.andalusian.
get_forms
()[source]¶ Get a list of Andalusian 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, "transliterated_name": Transliterated name of the form}
For additional information about each form use
get_form()
-
compmusic.dunya.andalusian.
get_instrument
(iid)[source]¶ Get specific information about an instrument.
- Parameters
iid – An instrument mbid
- Returns
id, name
-
compmusic.dunya.andalusian.
get_instruments
()[source]¶ Get a list of Andalusian 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, "original_name"}
For additional information about each instrument use
get_instrument()
-
compmusic.dunya.andalusian.
get_mizan
(mid)[source]¶ Get specific information about a mizan.
:param mid:A mizan mbid :returns: uuid, name, transliterated_name, display_order
-
compmusic.dunya.andalusian.
get_mizans
()[source]¶ Get a list of Andalusian mizan in the database. This function will automatically page through API results.
- Returns
A list of dictionaries containing mizan information:
{"uuid": Mizan uuid, "name": Name of the mizan, "transliterated_name": Transliterated name of the mizan}
For additional information about each mizan use
get_mizan()
.
-
compmusic.dunya.andalusian.
get_nawba
(nid)[source]¶ Get specific information about a nawba.
- Parameters
nid – A nawba mbid
- Returns
uuid, name, transliterated_name, display_order
-
compmusic.dunya.andalusian.
get_nawbas
()[source]¶ Get a list of Andalusian nawbas in the database. This function will automatically page through API results.
- Returns
A list of dictionaries containing nawba information:
{"uuid": Nawba uuid, "name": Name of the nawba, "transliterated_name": Transliterated name of the nawba}
For additional information about each nawba use :func:`get_nawba.
-
compmusic.dunya.andalusian.
get_recording
(rmbid)[source]¶ Get specific information about a recording.
- Parameters
rmbid – A recording mbid
- Returns
mbid, title, transliterated_name, musescore_url, archive url and sections.
sections
include information about the start and end time of the section, the name and the transliterated name.
-
compmusic.dunya.andalusian.
get_recordings
(recording_detail=False)[source]¶ Get a list of andalusian 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, "transliterated_title"}
For additional information about each recording use
get_recording()
.
-
compmusic.dunya.andalusian.
get_tab
(tid)[source]¶ Get specific information about a tab.
- Parameters
tid – A tab mbid
- Returns
uuid, name, transliterated_name, display_order.
-
compmusic.dunya.andalusian.
get_tabs
()[source]¶ Get a list of Andalusian tabs in the database. This function will automatically page through API results.
- Returns
A list of dictionaries containing tab information:
{"uuid": Mizan uuid, "name": Name of the tab, "transliterated_name": Transliterated name of the tab}
For additional information about each taal use
get_tab()
.
-
compmusic.dunya.andalusian.
get_work
(wmbid)[source]¶ Get specific information about a work.
- Parameters
wmbid – A work mbid
- Returns
mbid, title, recordings
-
compmusic.dunya.andalusian.
get_works
()[source]¶ Get a list of Andalusian 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()
.