knuckles 1.1.6

A Subsonic/OpenSubsonic API wrapper for Python.

Knuckles

An unopinionated OpenSubsonic API wrapper for Python.

Compatiblity

Knuckles only works with servers compatible with the REST API version 1.4.0 onwards (Subsonic 4.2+). It follows strictly the OpenSubsonic API Spec, being fully retro-compatible with the original Subsonic API.

Getting Started

Make It Available

First install the package:

python3 -m pip install knuckles

Or add it to your project:

project = [
    "knuckles>=1.1.0"
]

Using It

import knuckles

server = knuckles.Subsonic(
    # Adding https:// is done automatically,
    # /rest should never be added to the URL
    url = "example.com",
    user = "kutu",
    password = "caisopea",
    client = "knuckles client"
)

ping = server.system.ping()

# Print the supported version of the OpenSubsonic REST API
print(ping.version)

Learning More

To start making more complex interactions with the API make use of the API reference. Enjoy coding and good luck!

Acknowledgements

Created with :heart: by Jorge "Kutu" Dobón Blanco.