Go to file
Alban Féron 4a0437b5e2
Fix(?) watcher queue sometimes not stopping when asked
Ref #263
2024-04-14 15:59:51 +02:00
.github/workflows Drop Python 3.6 2023-01-01 14:00:20 +01:00
docs Add ListenBrainz documentation and tests 2024-03-18 22:58:03 -06:00
supysonic Fix(?) watcher queue sometimes not stopping when asked 2024-04-14 15:59:51 +02:00
tests Move a ListenBrainz test to the net suite 2024-04-01 12:33:57 +02:00
.coveragerc Updates for Travis and codecov 2017-12-10 22:31:12 +01:00
.gitignore add .vscode to gitignore 2020-11-28 12:13:23 +01:00
.readthedocs.yaml Add ReadTheDocs configuration file 2024-01-02 14:34:33 +01:00
LICENSE Setting a license 2014-03-02 18:31:32 +01:00
MANIFEST.in Remove old stuff 2021-11-12 11:31:03 +01:00
README.md Add ListenBrainz documentation and tests 2024-03-18 22:58:03 -06:00
ci-requirements.txt Tweaking test workflow 2020-11-22 15:17:05 +01:00
codecov.yml CI tweaks 2021-12-04 15:51:54 +01:00
config.sample Add ListenBrainz documentation and tests 2024-03-18 22:58:03 -06:00
pyproject.toml Build and include man pages in distributions 2021-12-31 18:05:43 +01:00
setup.cfg Drop Python 3.6 2023-01-01 14:00:20 +01:00
setup.py Replace distutils.dir_util.remove_tree() by shutil.rmtree(). 2023-06-13 15:50:11 -04:00

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
  • ListenBrainz 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, ListenBrainz and ChartLyrics).