You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Alban Féron 9db3549734
Bump API version to 1.12.0
5 days ago
.github/workflows Pony now has a stable release for Python 3.10 so we're compatible on this version too 8 months ago
docs Advertise hls endpoint as not supported 4 weeks ago
supysonic Bump API version to 1.12.0 5 days ago
tests Implement musicFolderId paramenter on various endpoints 4 weeks ago
.coveragerc Updates for Travis and codecov 5 years ago
.gitignore add .vscode to gitignore 2 years ago
LICENSE Setting a license 9 years ago
MANIFEST.in Remove old stuff 11 months ago
README.md Implement musicFolderId paramenter on various endpoints 4 weeks ago
ci-requirements.txt Tweaking test workflow 2 years ago
codecov.yml CI tweaks 10 months ago
config.sample CRLF -> LF 2 years ago
pyproject.toml Build and include man pages in distributions 9 months ago
setup.cfg Pony now has a stable release for Python 3.10 so we're compatible on this version too 8 months ago
setup.py Build and include man pages in distributions 9 months ago

README.md

Supysonic

Supysonic is a Python implementation of the Subsonic server API.

Build Status codecov Python

Current supported features are:

  • browsing (by folders or tags)
  • streaming of various audio file formats
  • transcoding
  • user or random playlists
  • cover art
  • starred tracks/albums and ratings
  • Last.fm scrobbling
  • Jukebox mode

Supysonic currently targets the version 1.12.0 of the Subsonic API. For more details, go check the API implementation status.

Documentation

Full documentation is available at https://supysonic.readthedocs.io/

Quickstart

Use the following commands to install Supysonic, create an admin user, define a library folder, scan it and start serving on port 5722 using Gunicorn.

$ pip install supysonic
$ pip install gunicorn
$ supysonic-cli user add MyUserName
$ supysonic-cli user setroles --admin MyUserName
$ supysonic-cli folder add MyLibrary /home/username/Music
$ supysonic-cli folder scan MyLibrary
$ supysonic-server

You should now be able to enjoy your music with the client of your choice!

But using only the above commands will use a default configuration and especially storing the database in a temporary directory. Head over to the documentaiton for full setup instructions, plus other options if you don't want to use Gunicorn.

Note that there's also an optional daemon that watches for library changes and provides support for other features such as the jukebox mode.

Development stuff

For those wishing to collaborate on the project, since Supysonic uses Flask you can use its development server which provides automatic reloading and in-browser debugging among other things. To start said server:

$ export FLASK_APP="supysonic.web:create_application()"
$ export FLASK_ENV=development
$ flask run

And there's also the tests (which require lxml to run):

$ pip install lxml
$ python -m unittest
$ python -m unittest tests.net.suite

The last command runs a few tests that make HTTP requests to remote third-party services (namely Last.fm and ChartLyrics).