mirror of
https://github.com/spl0k/supysonic.git
synced 2024-11-13 21:52:18 +00:00
94 lines
2.4 KiB
ReStructuredText
94 lines
2.4 KiB
ReStructuredText
Installing Supysonic
|
|
====================
|
|
|
|
Supysonic is written in Python and supports Python 3.6 through 3.10.
|
|
|
|
Linux
|
|
-----
|
|
|
|
Currently, only Debian-based distributions might provide Supysonic in their
|
|
package repositories. Install the package ``supysonic`` using :command:`apt`::
|
|
|
|
$ apt install supysonic
|
|
|
|
This will install Supysonic along with the minimal dependencies it needs to
|
|
run.
|
|
|
|
If you plan on using it with a MySQL or PostgreSQL database you also need the
|
|
corresponding Python package, ``python3-pymysql`` for MySQL or
|
|
``python3-psycopg2`` for PostgreSQL.
|
|
|
|
::
|
|
|
|
$ apt install python3-pymysql
|
|
|
|
::
|
|
|
|
$ apt install python3-psycopg2
|
|
|
|
For other distributions, you might consider installing with `pip`_ or from
|
|
:ref:`docker` images.
|
|
|
|
Windows
|
|
-------
|
|
|
|
.. note::
|
|
While Supysonic hasn't been thoroughly tested on Windows, it *should* work.
|
|
If something is broken, we're really sorry. Don't hesitate to `open an
|
|
issue`__ on GitHub.
|
|
|
|
__ https://github.com/spl0k/supysonic/issues
|
|
|
|
Most Windows users do not have Python installed by default, so we begin with
|
|
the installation of Python itself. To check if you already have Python
|
|
installed, open the *Command Prompt* (:kbd:`Win-R` and type :command:`cmd`).
|
|
Once the command prompt is open, type :command:`python --version` and press
|
|
Enter. If Python is installed, you will see the version of Python printed to
|
|
the screen. If you do not have Python installed, head over to the `Python
|
|
website`__ and install one of the `compatible Python versions`__. You need at
|
|
least Python 3.6, but you can go up to the latest 3.10.
|
|
|
|
Once Python is installed, you can install Supysonic using :command:`pip`. Refer
|
|
to the `installation instructions <pip_>`_ below for more information.
|
|
|
|
__ https://www.python.org/
|
|
__ https://www.python.org/downloads/windows/
|
|
|
|
|
|
.. _pip:
|
|
|
|
pip
|
|
---
|
|
|
|
Simply install the package ``supysonic`` with :command:`pip`::
|
|
|
|
$ 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
|
|
to install either ``gevent``, ``gunicorn`` or ``waitress``.
|
|
|
|
::
|
|
|
|
$ pip install gevent
|
|
|
|
::
|
|
|
|
$ pip install gunicorn
|
|
|
|
::
|
|
|
|
$ pip install waitress
|
|
|
|
If you plan on using it with a MySQL or PostgreSQL database you also need the
|
|
corresponding package, ``pymysql`` for MySQL or ``psycopg2-binary`` for
|
|
PostgreSQL.
|
|
|
|
::
|
|
|
|
$ pip install pymysql
|
|
|
|
::
|
|
|
|
$ pip install psycopg2-binary
|