Installation [Old and no longer supported]

This Installation method is no longer supported, please visit the new installation page.

This may work for the old version branch. It should work fine but I won't be able to support that version any longer.

Let's try to install syrics on your local machine

Downloading

Recommended:

Install git on your system

Windows:

For windows go to https://git-scm.com/download/win and follow the instructions to install Git in the CMD.

Git can also be installed using winget, if you have it then install using the command:

winget install --id Git.Git -e --source winget

Linux:

Debian Based

sudo apt install git-all

Arch Based

pacman -S git

Termux:

pkg install git

MacOS

 brew install git

After installing Git:

Open the CMD/Powershell/Terminal:

Open terminal in any folder inside which you want to download the program, use cd command to change directory. After that use the commands below:

git clone https://github.com/akashrchandran/syrics.git
cd syrics

On Windows

ren sample_config.json config.json

On Linux or Mac

mv sample_config.json config.json

Alternative (Without using Git)

This method exits for those who don't need git in their system, you will have to do the same way to update your app.

Click on the green button and click on Download zip or you can always use this link: Download ZIP. Unzip the downloaded syrics-main.zip to any folder you like for example ~/Music or ~/Documents.

After downloading syrics, rename the file sample_config.json to config.json, now you can set all your preferences inside config.json.

Installing

Linux:

sudo apt update
sudo apt install python3
pip install -r requirements.txt

Termux:

apt update
pkg update
pkg install python
pip install -r requirements.txt

MacOS:

If you haven't already installed Homebew: Run /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

brew install python 
pip3 install -r requirements.txt

Windows:

Now install a stable Python 3.6+ release from https://www.python.org/downloads/windows/ and remember to install the right x64 or x86 according to your PC. Make sure to check the box Add Python 3.6 to the PATH! Then run the below command in CMD/Powershell:

pip install -r requirements.txt

Updating

Using Git

If you used the Recommended installation way you can easily update your existing installation (all your created sessions will still be intact, so you don't need to create new ones):

git pull
pip install -r requirements.txt

Non-git

If you have used the Alternative installation way, then just download the same zip again and copy the config.json from the old to new.