spicetify-websocket 0.3.0

An asynchronous Python wrapper and WebSocket server for controlling the Spotify desktop client via Spicetify and the spicetify-connect-api extension.

✨ Features

• ⚡ Real-time Push Events: Instant updates for song changes, volume, seeking, shuffle, repeat, heart/like status, and ping heartbeats.
• 🌐 Wildcard State Decorator: Listen to every state update event with a single @server.on_state_changed decorator.
• 🎮 Full Playback Control: Play, pause, skip, seek, volume, repeat, shuffle, and ping latency checks.
• 🔑 API Key Security: Optional token authorization for securing command execution and event streaming.
• 🔒 Secure WebSockets (WSS): Built-in SSL/TLS support via ssl_context or certfile/keyfile.
• 🏷️ Rich & Fully Typed Models: Complete Pydantic V2 models.
• 🔄 Async & Non-blocking: Built on asyncio and websockets for maximum performance.

⚙️ Installation

Python 3.10 or higher is required.

pip install spicetify-websocket

📋 Prerequisites

To use this library, ensure you have:

1. Spotify Desktop Client installed.
2. Spicetify CLI installed and configured.
3. The spicetify-connect-api extension enabled in Spicetify.

📚 Documentation & Guides

Explore the official documentation for detailed references and setup guides:

• 📖 API Reference – Full documentation for SpotifyServer, models, decorators, and exceptions.
• 💡 Code Examples – Runnable scripts for basic usage, API key auth, and WSS encryption.
• 🛠️ Deployment Guides – Step-by-step guides for local WSS setups and production VPS deployment.

🚀 Example Usage

import asyncio
from spicetify import PlayerState, RepeatMode, SpotifyServer


async def main():
    async with SpotifyServer() as server:
        # Event handler for song changes
        @server.on_song_changed
        def on_song_changed(state: PlayerState):
            track = state.track
            if track:
                print("New song is playing:", track.title)
                print("Artist/s:", ", ".join(artist.name for artist in track.artists))

        # Wait until Spicetify client connects
        await server.wait_for_connection()

        # Playback State Query
        is_playing: bool = await server.get_is_playing()
        print("Is Spotify playing:", is_playing)

        # Playback Controls
        await server.play_url(url="https://open.spotify.com/intl-de/track/55pBIZO1cqoldeqpp5WR7H")
        await server.set_volume(percent=75)
        await server.set_repeat(mode=RepeatMode.TRACK)

        # Keep the server running to receive events
        await asyncio.Event().wait()


if __name__ == "__main__":
    asyncio.run(main())

📻 Events Reference

All state-related event handlers receive a comprehensive PlayerState object containing the full player snapshot.