Metadata-Version: 2.1
Name: repertorio
Version: 0.0.2
Summary: A setlist.fm API wrapper.
Home-page: https://github.com/jtmolon/repertorio
Author: Joao Molon
Author-email: jtmolon@gmail.com
License: MIT license': 'License :: OSI Approved :: MIT License
Keywords: repertorio setlist set list setlistfm setlist.fm
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst

==========
Repertorio
==========

.. image:: https://travis-ci.org/jtmolon/repertorio.svg?branch=master
    :target: https://travis-ci.org/jtmolon/repertorio

.. image:: https://coveralls.io/repos/github/jtmolon/repertorio/badge.svg?branch=master
    :target: https://coveralls.io/github/jtmolon/repertorio?branch=master


**Repertorio** is a `setlist.fm <https://www.setlist.fm/>`_ API wrapper for Python. It provides an interface to query the setlist.fm endpoints and look for artists, venues, setlists and such.

For more information on the setlist.fm API, please refer to the `documentation <https://api.setlist.fm/docs/1.0/index.html>`_.

For the full documentation refer to `Repertorio documentation <https://repertorio.readthedocs.io/en/latest/>`_.

Usage
-----

::

  from repertorio import Repertorio
  api = Repertorio('setlistfm-api-key')
  api.artists(artistName='alice', sort='relevance')


Search endpoints
----------------

The API search endpoints return multiple results, in case of match, and require keyword arguments to perform the query. Refer to the `API documentation <https://api.setlist.fm/docs/1.0/index.html>`_ for details of supported keyword arguments and response formats.

::

    api.artists(artistName='foo')
    api.cities(name='caxias do sul')
    api.countries()  # countries is an exception, it doesn't require or support any keyword arguments
    api.setlists(artistName='foo')
    api.venues(name='olympia theatre')


Resource endpoints
------------------

The API resource endpoints return a single result and, as such, require a "primary key" argument to perform the query. Refer to the `API documentation <https://api.setlist.fm/docs/1.0/index.html>`_ for further details.

::

    api.artist('artist-mbid')
    api.artist_setlists('artist-mbid')
    api.city('city-geoId')
    api.setlist('setlistId')
    api.setlist_version('versionId')
    api.user('userId')
    api.user_attended('userId')
    api.user_edited('userId')
    api.venue('venueId')
    api.venue_setlists('venueId')


