https://github.com/kutu-dev/knuckles

A Subsonic/OpenSubsonic API wrapper for Python.
https://github.com/kutu-dev/knuckles

api api-wrapper library opensubsonic python subsonic wrapper

Last synced: 5 months ago
JSON representation

A Subsonic/OpenSubsonic API wrapper for Python.

• Host: GitHub
• URL: https://github.com/kutu-dev/knuckles
• Owner: kutu-dev
• License: apache-2.0
• Created: 2023-07-22T00:25:11.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-03T14:41:44.000Z (over 1 year ago)
• Last Synced: 2024-08-09T03:52:29.570Z (about 1 year ago)
• Topics: api, api-wrapper, library, opensubsonic, python, subsonic, wrapper
• Language: Python
• Homepage: https://kutu-dev.github.io/knuckles/
• Size: 1.11 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          


Knuckles


![PyPI - Version](https://img.shields.io/pypi/v/knuckles)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/knuckles)

![GitHub Actions - PyPI Publishing](https://github.com/kutu-dev/knuckles/actions/workflows/publish.yml/badge.svg)

![GitHub Actions - Docs Deploying](https://github.com/kutu-dev/knuckles/actions/workflows/docs.yml/badge.svg)

An unopinionated [OpenSubsonic](https://opensubsonic.netlify.app/) 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](https://opensubsonic.netlify.app/docs/opensubsonic-api/), being fully retro-compatible with the original [Subsonic API](https://subsonic.org/pages/api.jsp).

## Getting Started

### Make It Available

First install the package:

```sh title="Command line"

python3 -m pip install knuckles

```

Or add it to your project:

```toml title="pyproject.toml"

project = [

    "knuckles>=1.1.0"

]

```

### Using It

```python3 title="__main__.py"

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](https://kutu-dev.github.io/knuckles/reference/Api/). Enjoy coding and good luck!

## Acknowledgements

Created with :heart: by [Jorge "Kutu" Dobón Blanco](https://dobon.dev).