Asteroid

Music Server for parties and social gatherings.

Install

Prerequisites

• git
• python3
• pip
• exiftool
• alsaaudio
• jsdoc

Installation

# Clone the repository
$ git clone https://github.com/Moontemple/Asteroid
# Navigate into cloned repository
$ cd Asteroid
# Setup the virtual environment using venv
$ python3 -m venv venv

Once a virtual environment has been created, it can be “activated” using a script in the virtual environment’s binary directory.

# bash/zsh
$ source venv/bin/activate
# fish
$ . venv/bin/activate.fish
# csh/tcsh
$ source venv/bin/activate.csh
# cmd.exe
C:\> venv\Scripts\activate.bat
# PowerShell
PS C:\> venv\Scripts\Activate.ps1

# Install Asteroid in the virtual environment
$ pip install -r requirements.txt
# Test and build the docs (Optional)
$ pytest -v && (cd docs; make html; cd ..)

To exit the virtual environment use the 'deactivate' script.

# Posix shells
$ deactivate
# cmd.exe
C:\> deactivate.bat
# PowerShell
PS C:\> Deactivate.ps1

Running

# Ensure the virtual environment is activated
$ source venv/bin/activate
# Run with python and print help message
$ python run.py -h

# To configure a new database
$ python run.py database --fresh
# To load in music
$ python run.py database music --load [path to dir with .wav files]

# For more help on a command
$ python run.py {database,flask,player} -h