github/supysonic
1
0
Fork 0
mirror of https://github.com/spl0k/supysonic.git synced 2024-09-19 10:51:04 +00:00
Code Issues Releases Wiki Activity

Supysonic is going to PyPI, update the docs accordingly

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
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 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][]. 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 $ pip install gunicorn
$ supysonic-cli user add MyUserName $ supysonic-cli user add MyUserName
$ supysonic-cli user setroles --admin MyUserName $ supysonic-cli user setroles --admin MyUserName

2
docs/setup/deploying/wsgi-standalone.rst
View File

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

2
docs/setup/index.rst
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 pip install gunicorn
supysonic-server supysonic-server

25
docs/setup/install.rst
View File

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