Metadata-Version: 2.1
Name: slskd-api
Version: 0.1.5
Summary: API Wrapper to interact with slskd
Author: bigoulours
License: GNU Affero General Public License v3.0
Project-URL: Documentation, https://slskd-api.readthedocs.io
Project-URL: Source, https://github.com/bigoulours/slskd-python-api
Project-URL: Funding, https://liberapay.com/bigoulours/donate
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: requests>=2.25.1

# slskd-api

## Goal
This project provides a python API for [slskd](https://github.com/slskd/slskd).

A comprehensive python API should help improve integration and increase slskd adoption by enabling rapid development of various software, such as:
 - [ ] Desktop/Mobile Clients
 - [ ] [beets](https://github.com/beetbox/beets) plugin(s)
 - [ ] [headphones](https://github.com/rembo10/headphones) integration

## Installation
The package is availaible on [pypi](https://pypi.org/project/slskd-api/):
```
pip install slskd-api
```

## Usage
Create a `slskd` instance with the following:
```
import slskd_api
slskd = slskd_api.SlskdClient(host, api_key, url_base)
```
Then you'll be able to access all API methods:
```
app_status = slskd.application.state()
available_rooms = slskd.rooms.get_all()
```
See the [doc](https://slskd-api.readthedocs.io/) for further details.
