Control spotify with Shell GPT

[SpaceShaman]

This AI function allows you to control Spotify with Shell GPT. You can ask it to play a song, pause, skip, or even ask to find a song for you and add it to your playlist.
All commands from the Spotify API are supported.

spotify-2024-04-21_17.18.14.mp4

spotify-2024-04-21_17.51.42.mp4

How to use

1. Install the requirements

   pip install spotipy

2. Create a Spotify app and get the client ID and client secret. You can do this by going to the Spotify Developer Dashboard and creating a new app.

3. Add the client ID and client secret to the ~/.config/shell_gpt/.sgptrc file.

   SPOTIFY_CLIENT_ID = "your_client_id"
   SPOTIFY_CLIENT_SECRET = "your_client_secret"

4. Save below code as spotify.py in the ~/.config/shell_gpt/functions directory.

    import inspect
    import os
    from pathlib import Path
    from typing import Any, Literal
   
    from dotenv import load_dotenv
    from instructor import OpenAISchema
    from pydantic import Field
    from spotipy import Spotify
    from spotipy.oauth2 import SpotifyOAuth
   
    load_dotenv(Path(__file__).parent.parent / ".sgptrc")
   
    SPOTIFY_CLIENT_ID = os.getenv("SPOTIFY_CLIENT_ID")
    SPOTIFY_CLIENT_SECRET = os.getenv("SPOTIFY_CLIENT_SECRET")
   
    SCOPES = [
        "user-read-playback-state",
        "user-modify-playback-state",
        "user-read-currently-playing",
        "app-remote-control",
        "streaming",
        "playlist-read-private",
        "playlist-read-collaborative",
        "playlist-modify-private",
        "playlist-modify-public",
        "user-follow-modify",
        "user-follow-read",
        "user-read-playback-position",
        "user-top-read",
        "user-read-recently-played",
        "user-library-modify",
        "user-library-read",
    ]
   
    spotify = Spotify(
        auth_manager=SpotifyOAuth(
            client_id=os.getenv("SPOTIFY_CLIENT_ID"),
            client_secret=os.getenv("SPOTIFY_CLIENT_SECRET"),
            redirect_uri="http://localhost:3000",
            scope=" ".join(SCOPES),
            cache_path=Path(__file__).parent.parent / ".cache",
        )
    )
   
   
    def get_spotify_methods():
        methods = []
        for method_name in dir(Spotify):
            method = getattr(spotify, method_name)
   
            if callable(method) and not method_name.startswith("_"):
                description = getattr(spotify, method_name).__doc__
                if isinstance(description, str):
                    description = (
                        description[: description.index("\n")].strip()
                        if "\n" in description
                        else description
                    )
                    methods.append(
                        f"{method_name}{inspect.signature(getattr(spotify, method_name))}: {description}"
                    )
        return methods
   
   
    class Function(OpenAISchema):
        """Control spotify via api.
        Always pass function_call.name as 'spotify'.
        Pass function name to execute as function_call.arguments.method.
        Pass arguments as key value pairs in function_call.arguments.
        Never nest arguments deeper than function_call.arguments.
        Example:
        {
            'name': 'spotify',
            'arguments': {
                'method': 'search',
                'q': 'taylor swift',
                'limit': 1,
                'type': 'artist',
        }
        """
   
        method: Literal[*get_spotify_methods()] = Field(  # type: ignore
            ...,
            description="Method to call, return only the method name as method argument",
        )
   
        class Config:
            title = "spotify"
   
        @classmethod
        def execute(cls, *args, **kwargs) -> Any:
            arguments = kwargs.pop("arguments") if "arguments" in kwargs else kwargs
            method = arguments.pop("method")
            try:
                result = getattr(spotify, method)(**arguments)
            return "Success" if result is None else str(result)
        except Exception as e:
            return str(e)

[TheR1D]

This is so cool, nice work! I like the way you are pulling out method names and description from the lib.