py-opensonic
A python library for interacting with an Open Subsonic API implementation. This started its life as the py-sonic library. I have tested with Gonic (and continue to do so against each stable docker release). Please open issues if you discover problems with other implementations.
As of 10.0.0 we have stopped using unasync and instead the sychronous Connection object is a thin wrapper around the AsyncConnection that runs an event loop and makes async method calls for the user.
As of 9.0.0 we use unasync to generate the synchronous Connection class from the Async one. This will stop us from having to maintain duplicate code in the two classes. If you submit a PR that changes the Async class, please be sure to run scripts/gen_sync.py and add the resulting changes to the synchronous class as well.
Any PRs that change the synchronous class by hand or without updating the asynchronous one and/or the gen_sync.py script will be immediately closed.
As of 8.0.0 this library now offers an AsyncConnection object that uses aiohttp for all its http requests. It does not create an event loop so is usable inside any application built on asyncio. The Connection object will continue to use synchronous IO and will remain for backward compatibility.
INSTALL
Installation is fairly simple. Just do the standard install as root:
tar -xvzf py-opensonic-*.tar.gz
cd py-opensonic-*
python setup.py install
You can also install directly using pip or easy_install
pip install py-opensonic
USAGE
This library follows the REST API almost exactly (for now). If you follow the documentation on https://opensubsonic.netlify.app/docs/ or you do a:
pydoc libopensonic.connection
The py-sonic original author has added documentation at http://stuffivelearned.org/doku.php?id=programming:python:py-sonic
BASIC TUTORIAL
This is about as basic as it gets. We are just going to set up the connection and then get a couple of random songs.
#!/usr/bin/env python
import libopensonic
# We pass in the base url, the username, password, and port number
# Be sure to use https:// if this is an ssl connection!
conn = libopensonic.Connection('https://music.example.com' , 'myuser' ,
'secretpass' , port=443)
# Let's get 2 completely random songs
songs = conn.get_random_songs(size=2)
# We'll just pretty print the results we got to the terminal
print(songs[0])
print(songs[1])
As you can see, it's really pretty simple. If you use the documentation provided in the library:
pydoc libopensonic.connection
or the api docs on opensubsonic.netlify.app (listed above), you should be able to make use of your server without too much trouble.
Async/Sync Cohabitation
As of 9.0.0 we use unasync to generate the synchronous Connection class from the Async one. This will stop us from having to maintain duplicate code in the two classes. If you submit a PR that changes the Async class, please be sure to run scripts/gen_sync.py and add the resulting changes to the synchronous class as well.
Any PRs that change the synchronous class by hand or without updating the asynchronous one and/or the gen_sync.py script will be immediately closed.
pytest
There are now pytest unit tests which are configured to run on any new PR, these tests must be passing to merge. Please add tests to any fixes or new features.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file py_opensonic-10.2.0.tar.gz.
File metadata
- Download URL: py_opensonic-10.2.0.tar.gz
- Upload date:
- Size: 51.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0004d8f5fbca82bf5a599db986945d379cea3f583ec5086e0904f0ecadd42e4e
|
|
| MD5 |
31839e942f4d1189c676a328a58cc042
|
|
| BLAKE2b-256 |
ce3435d80dc6d35e82bdc7549ba769f9bc81255113f4c80c333d1e29de0c1f0c
|
File details
Details for the file py_opensonic-10.2.0-py3-none-any.whl.
File metadata
- Download URL: py_opensonic-10.2.0-py3-none-any.whl
- Upload date:
- Size: 42.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.25
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6a9fe92379dceceb85267d9e0f787841720c3b4282223162d4721211da67e5a6
|
|
| MD5 |
f754e5b0c69004f84735494d42e244be
|
|
| BLAKE2b-256 |
51ae90dc89d949b06cadb0cfdde768b52e43beb08b1aaa764922cdbf40bf9b3c
|
