Skip to main content

a python client for the setlist.fm api

Project description

test PyPI version Documentation Status codecov License: MIT Code style: black Imports: isort PyPI - Python Version

setlist-fm-client

setlist-fm-client is a python client for the setlist.fm REST API.

Installation

pip

pip install setlist-fm-client

poetry

poetry add setlist-fm-client

Help

See the documentation for more details.

Authentication

In order to authenticate to the setlist.fm REST API, you must apply for an API key (link for logged-in users only) - if you're not registered user yet, then register first (it's free).

Once you have your key, you can use it in the setlist-fm-client by setting the SETLIST_FM_API_KEY environment variable or by passing api_key="xxx" as a kwarg to any function (see docs).

Simple Example

setlist-fm-client is extremely easy to use. By setting serialize=True, you get a pydantic model returned to you instead of a httpx.Response object.

Below are examples of what the code looks like for both the sync and async apis.

sync

import setlist_fm_client

setlists = setlist_fm_client.get_artist_setlists(
    "0bfba3d3-6a04-4779-bb0a-df07df5b0558", api_key="xxx", serialize=True
)
print(setlists)

async

import asyncio 

import setlist_fm_client

async def main():
    setlists = await setlist_fm_client.get_artist_setlists(
        "0bfba3d3-6a04-4779-bb0a-df07df5b0558", api_key="xxx", serialize=True
    )
    print(setlists)

asyncio.run(main())

This will give you an ArtistSetListResponse object.

Buy me a coffee

If you find this project useful, consider buying me a coffee!

Buy Me A Coffee

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

setlist-fm-client-0.4.0.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

setlist_fm_client-0.4.0-py3-none-any.whl (10.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page