github/supysonic
1
0
Fork 0
mirror of https://github.com/spl0k/supysonic.git synced 2024-12-22 08:56:17 +00:00
Code Issues Releases Wiki Activity
682 Commits 6 Branches 18 Tags 2.6 MiB
Python 89%
HTML 10.5%
JavaScript 0.4%
CSS 0.1%
359e391fcc
Go to file
Carey Metcalfe 359e391fcc Implement recursive downloading of folders 
Example use case:
```
Some Album/
├── CD1
│   └── <songs>
├── CD2
│   └── <songs>
└── cover.jpg
```

Previously, downloading the `Some Album` folder would result in no data
being sent (not even `cover.jpg`)

This commit changes folder-based downloads so that the entire folder
tree (including any non-music) is added to the returned zip file. This
allows any included album art, scans, notes, etc. to be distributed with
the files.

Album-based downloads are unaffected.
2021-10-08 00:48:45 -04:00
.github/workflows Advertising (and testing) Python 3.9 support 2020-11-25 21:24:59 +01:00
bin Removing shebang and executable flag from explicit python files 2020-11-22 16:28:26 +01:00
cgi-bin Removing shebang and executable flag from explicit python files 2020-11-22 16:28:26 +01:00
docs Allow renaming users with the CLI 2021-02-07 16:35:55 +01:00
supysonic Implement recursive downloading of folders 2021-10-08 00:48:45 -04:00
tests Added test for #221 2021-09-18 17:00:02 +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
ci-requirements.txt Tweaking test workflow 2020-11-22 15:17:05 +01:00
config.sample CRLF -> LF 2021-01-23 15:44:15 +01:00
LICENSE Setting a license 2014-03-02 18:31:32 +01:00
MANIFEST.in First throw at automatic database migrations 2018-08-29 17:46:59 +02:00
README.md Usage doc 2021-01-24 17:49:18 +01:00
setup.py Switch to using zipstream-ng to generate and stream zip files 2021-10-08 00:38:09 -04:00
supysonic-daemon.service Docs update + systemd service file for the daemon 2019-06-10 17:25:05 +02: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
  • Jukebox mode

Supysonic currently targets the version 1.10.2 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 using Gunicorn.

$ pip install git+https://github.com/spl0k/supysonic.git
$ 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
$ gunicorn -b 0.0.0.0:5000 "supysonic.web:create_application()"

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:

$ python setup.py test
$ python setup.py test --test-suite tests.with_net