MetaBrainz Foundation

Add ListenBrainz API usage examples to documentation

ListenBrainz has a native API which is documented on readthedocs. We have a list of all endpoints that the API supports. However, having code that shows example usage of these endpoints in the documentation would make the API much more developer-friendly.

This task involves adding ListenBrainz API usage examples to the ListenBrainz documentation. You should add a new file, maybe api-usage.rst and write example code in Python that makes use of each of the API endpoints of ListenBrainz listed on the readthedocs reference page.

Also, document example inputs and outputs for each endpoint in the docs.

Task tags

  • python
  • restructuredtext
  • listenbrainz
  • documentation

Students who completed this task

Eshan Singh

Task type

  • code Code
  • chrome_reader_mode Documentation / Training