Carnatic API¶
-
compmusic.dunya.carnatic.
download_concert
(concert_id, location)[source]¶ Download the mp3s of all recordings in a concert and save them to the specificed directory.
- Parameters
concert – The MBID of the concert
location – Where to save the mp3s to
-
compmusic.dunya.carnatic.
download_mp3
(recordingid, location)[source]¶ 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.carnatic.
get_artist
(ambid)[source]¶ Get specific information about an artist.
- Parameters
ambid – An artist MBID
- Returns
mbid, name, concerts, instruments, recordings.
concerts
,instruments
andrecordings
include information from recording- and release-level relationships, as well as release artists
-
compmusic.dunya.carnatic.
get_artists
()[source]¶ Get a list of Carnatic 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.carnatic.
get_concert
(cmbid)[source]¶ Get specific information about a concert.
- Parameters
cmbid – A concert mbid
- Returns
mbid, title, artists, tracks.
artists
includes performance relationships attached to the recordings, the release, and the release artists.
-
compmusic.dunya.carnatic.
get_concerts
()[source]¶ Get a list of Carnatic concerts in the database. This function will automatically page through API results.
- Returns
A list of dictionaries containing concert information:
{"mbid": MusicBrainz Release ID, "title": title of the concert}
For additional information about each concert use
get_concert()
-
compmusic.dunya.carnatic.
get_instrument
(iid)[source]¶ 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.carnatic.
get_instruments
()[source]¶ Get a list of Carnatic 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.carnatic.
get_raaga
(rid)[source]¶ Get specific information about a raaga.
- Parameters
rid – A raaga id or uuid
- Returns
uuid, name, artists, works, composers.
artists
includes artists with recording- and release- level relationships to a recording with this raaga
-
compmusic.dunya.carnatic.
get_raagas
()[source]¶ Get a list of Carnatic raagas in the database. This function will automatically page through API results.
- Returns
A list of dictionaries containing raaga information:
{"uuid": raaga UUID, "name": name of the raaga}
For additional information about each raaga use
get_raaga()
-
compmusic.dunya.carnatic.
get_recording
(rmbid)[source]¶ Get specific information about a recording.
- Parameters
rmbid – A recording MBID
- Returns
mbid, title, artists, raaga, taala, work.
artists
includes performance relationships attached to the recording, the release, and the release artists.
-
compmusic.dunya.carnatic.
get_recordings
(recording_detail=False)[source]¶ Get a list of carnatic 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.carnatic.
get_taala
(tid)[source]¶ Get specific information about a taala.
- Parameters
tid – A taala id or uuid
- Returns
uuid, name, artists, works, composers.
artists
includes artists with recording- and release- level relationships to a recording with this raaga
-
compmusic.dunya.carnatic.
get_taalas
()[source]¶ Get a list of Carnatic taalas in the database. This function will automatically page through API results.
- Returns
A list of dictionaries containing taala information:
{"uuid": taala UUID, "name": name of the taala}
For additional information about each taala use
get_taala()
.
-
compmusic.dunya.carnatic.
get_work
(wmbid)[source]¶ Get specific information about a work.
- Parameters
wmbid – A work mbid
- Returns
mbid, title, composers, raagas, taalas, recordings
-
compmusic.dunya.carnatic.
get_works
()[source]¶ Get a list of Carnatic 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()
.