Installing Supysonic

Supysonic is written in Python and supports Python 3.5+.

Linux

Currently, only Debian-based distributions might provide Supysonic in their package repositories. Install the package supysonic using apt:

$ apt install supysonic

This will install Supysonic along with the minimal dependencies it needs to run.

Note

As of January 2021, Supysonic only reached Debian’s testing release. If you’re using the stable release it might not be available in the packages yet.

If you plan on using it with a MySQL or PostgreSQL database you also need the corresponding Python package, python-pymysql for MySQL or python-psycopg2 for PostgreSQL.

$ apt install python-pymysql

$ apt install python-psycopg2

For other distributions, you might consider installing from Docker images or from source.

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.

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 (Win-R and type cmd). Once the command prompt is open, type 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, refer to the Hitchhikers Guide to Python’s Python on Windows installation guides. You must install Python 3.

Once Python is installed, you can install Supysonic using pip. Refer to the source installation instructions below for more information.

Source

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:

$ git clone https://github.com/spl0k/supysonic.git
$ cd supysonic
$ pip install .

or simply installing directly via pip:

$ pip install git+https://github.com/spl0k/supysonic.git

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 package, pymysql for MySQL or psycopg2-binary for PostgreSQL.

$ pip install pymysql

$ pip install psycopg2-binary