music.api

Module contents

Flask blueprints for loading the app endpoints

api.admin

music.api.admin.get_tasks(auth=None, user=None)

api.api

music.api.api.all_playlists_route(auth=None, user=None)

Retrieve all playlists for a given user

Parameters:

user ([type], optional) – [description]. Defaults to None.

Returns:

All playlists for given user

Return type:

HTTP Response

music.api.api.all_users_route(auth=None, user=None)
music.api.api.change_password(user=None)
music.api.api.image(auth=None, user=None)
music.api.api.playlist_get_delete_route(auth=None, user=None)
music.api.api.playlist_post_put_route(auth=None, user=None)
music.api.api.run_playlist(auth=None, user=None)
music.api.api.run_playlist_task()
music.api.api.run_user(auth=None, user=None)
music.api.api.run_user_task()
music.api.api.run_users(auth=None, user=None)
music.api.api.user_delete_route(auth=None, user=None)
music.api.api.user_route(auth=None, user=None)

api.decorators

music.api.decorators.admin_required(func)
music.api.decorators.check_dict(request_params, expected_args, func, args, kwargs)
music.api.decorators.cloud_task(func)
music.api.decorators.gae_cron(func)
music.api.decorators.is_basic_authed()
music.api.decorators.is_jwt_authed()
music.api.decorators.is_logged_in()
music.api.decorators.jwt_required(func)
music.api.decorators.lastfm_username_required(func)
music.api.decorators.login_or_basic_auth(func)
music.api.decorators.login_or_jwt(func)
music.api.decorators.login_required(func)
music.api.decorators.no_cache(func)
music.api.decorators.no_locked_users(func)
music.api.decorators.validate_args(*expected_args)
music.api.decorators.validate_json(*expected_args)

api.fm

music.api.fm.daily_scrobbles(auth=None, user=None)

api.player

music.api.player.next_track(auth=None, user=None)
music.api.player.play(auth=None, user=None)
music.api.player.shuffle(auth=None, user=None)
music.api.player.volume(auth=None, user=None)

api.spotfm

music.api.spotfm.count(auth=None, user=None)
music.api.spotfm.playlist_refresh(auth=None, user=None)
music.api.spotfm.run_playlist_album_task()
music.api.spotfm.run_playlist_artist_task()
music.api.spotfm.run_playlist_track_task()
music.api.spotfm.run_user(auth=None, user=None)
music.api.spotfm.run_user_task()
music.api.spotfm.run_users(auth=None, user=None)

api.spotify

music.api.spotify.sort(auth=None, user=None)

api.tag

music.api.tag.delete_tag(tag_id, user)
music.api.tag.get_tag(tag_id, user)
music.api.tag.post_tag(tag_id, user)
music.api.tag.put_tag(tag_id, user)
music.api.tag.run_tag_task()
music.api.tag.tag_refresh(tag_id, auth=None, user=None)
music.api.tag.tag_route(tag_id, auth=None, user=None)
music.api.tag.tags(auth=None, user=None)