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.
Metadata
Release files for knuckles 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| knuckles-1.2.0.tar.gz | 41.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| knuckles-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 106.4 kB
Release files / knuckles-1.2.0.tar.gz
| Download URL | knuckles-1.2.0.tar.gz |
|---|---|
| Size | 41.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b68b7d8f3e6bab9cd2e40756dac07ff607dcdec244e1bd1c9de2b63e712eedda
|
|
BLAKE2b-256 checksum How to use checksums |
6370bc05617890d981cb79931de0eea770ee7899c16e4e2e3055d28a9598e8a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 24, 2024.
Transparency logRelease files / knuckles-1.2.0-py3-none-any.whl
| Download URL | knuckles-1.2.0-py3-none-any.whl |
|---|---|
| Size | 64.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
644d93b03b0929c91520d814e814c4bb2136db94ad1c550a72aada33a8a6d882
|
|
BLAKE2b-256 checksum How to use checksums |
2088489ca65dccc47f8bf93d3d10aee87072d6b22eee22ea7e0aca210177ca32
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 24, 2024.
Transparency log