1
0
mirror of https://github.com/spl0k/supysonic.git synced 2024-12-22 08:56:17 +00:00

Supysonic is going to PyPI, update the docs accordingly

This commit is contained in:
Alban Féron 2021-11-21 17:51:44 +01:00
parent 3b0023e1ac
commit 56fe87af97
No known key found for this signature in database
GPG Key ID: 8CE0313646D16165
4 changed files with 11 additions and 20 deletions

View File

@ -32,7 +32,7 @@ Full documentation is available at https://supysonic.readthedocs.io/
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 git+https://github.com/spl0k/supysonic.git
$ pip install supysonic
$ pip install gunicorn
$ supysonic-cli user add MyUserName
$ supysonic-cli user setroles --admin MyUserName

View File

@ -69,7 +69,7 @@ __ https://uwsgi-docs.readthedocs.io/en/latest/
__ https://flask.palletsprojects.com/en/2.0.x/deploying/uwsgi/
Waitress
========
--------
`Waitress`__ is meant to be a production-quality pure-Python WSGI server with
very acceptable performance. It has no dependencies except ones which live in

View File

@ -13,7 +13,7 @@ music is located 😏). This uses `gunicorn`__, but there are
::
pip install git+https://github.com/spl0k/supysonic.git
pip install supysonic
pip install gunicorn
supysonic-server

View File

@ -26,8 +26,8 @@ corresponding Python package, ``python-pymysql`` for MySQL or
$ apt install python-psycopg2
For other distributions, you might consider installing from :ref:`docker` images
or from `source`_.
For other distributions, you might consider installing with `pip`_ or from
:ref:`docker` images.
Windows
-------
@ -49,26 +49,19 @@ Guide to Python's`__ Python on Windows installation guides. You must install
`Python 3`__.
Once Python is installed, you can install Supysonic using :command:`pip`. Refer
to the `source installation instructions <source_>`_ below for more information.
to the `installation instructions <pip_>`_ below for more information.
__ https://docs.python-guide.org/
__ https://docs.python-guide.org/starting/install3/win/
.. _source:
.. _pip:
Source
------
pip
---
You can install Supysonic directly from a clone of the `Git repository`__. This
can be done either by cloning the repo and installing from the local clone::
Simply install the package ``supysonic`` with :command:`pip`::
$ git clone https://github.com/spl0k/supysonic.git
$ cd supysonic
$ pip install .
or simply installing directly via :command:`pip`::
$ pip install git+https://github.com/spl0k/supysonic.git
$ pip install supysonic
This will install Supysonic along with the minimal dependencies it needs, but
those don't include the requirements for the web server. For this you'll need
@ -97,5 +90,3 @@ PostgreSQL.
::
$ pip install psycopg2-binary
__ https://github.com/spl0k/supysonic