Skip to main content

Communicate with the Spotify's web helper process to control some basic aspects of spotify

Project description

Spotify-Local: A multi-platform API to control the local Spotify Client

https://img.shields.io/pypi/v/requests-xml.svg?maxAge=2592000 https://img.shields.io/pypi/l/requests-xml.svg?maxAge=2592000

Spotify-Local library is designed to make controlling the Spotify client on your local machine possible! This is a wrapper for the web helper process which exposes a simple api. Spotify-Local is inspired by SpotifyAPI-NET. This library allows you to perform simple actions quickly, or listen to events and register callbacks when a song changes, or the pause button is pushed.

When using this library you automatically get:

  • The ability to play/pause the current song

  • The ability to change tracks

  • You can register callbacks and listen for events when the state of Spotify changes

  • A nice context manager api using with

Installation

$ pipenv install spotify-local

Only Python 3.3+ is supported.

Tutorial & Usage

Connect to the Spotify Client (Spotify must be open to do this):

>>> from spotify_local import SpotifyLocal

>>> with SpotifyLocal() as s:
        pass

Pause the Spotify Client:

>>> with SpotifyLocal() as s:
        s.pause()

Grab the current state of the Spotify client, including now playing information:

>>> with SpotifyLocal() as s:
        print(s.get_current_status())

Play a playlist, song, album, artist, etc using a Spotify uri link:

>>> with SpotifyLocal() as s:
        s.playURI('spotify:track:0thLhIqWsqqycEqFONOyhu')

Register a callback and listen for events:

>>> from spotify_local import SpotifyLocal
>>> s = SpotifyLocal()
>>> @s.on('track_change')
>>> def test(event):
...     print(event)
>>> s.listen(blocking=False)
>>> print("Do more stuff because that runs in the background")

License

MIT

TODO

  • Create an async verion of the spotify controller class

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

spotify-local-0.3.2.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

spotify_local-0.3.2-py2.py3-none-any.whl (5.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file spotify-local-0.3.2.tar.gz.

File metadata

File hashes

Hashes for spotify-local-0.3.2.tar.gz
Algorithm Hash digest
SHA256 39e92cd94ad35160f060e9addc68d553410b1872df4b0c9065910baa8548dd73
MD5 0d88b071e8df7244b8f5cdd409351979
BLAKE2b-256 9dd372b37845908121d782439ea2e105d8e988a1a359d165d32b530876fec113

See more details on using hashes here.

File details

Details for the file spotify_local-0.3.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for spotify_local-0.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 480a2b552aced591723cd524247b76ac5b18380ea485c5ecf5baa29caac95383
MD5 039149051c773430b05e8a74cd19e811
BLAKE2b-256 a104ee013f4b249e155eeab0bd2d6323f3b5c7da23093997f18ad5b107c7acf2

See more details on using hashes here.

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