Install MySQL Server*** - more on this later

brew install mysql

If not yet done so, install python verion 2.7 & virtualenv

brew install python
pip install virtualenv

Clone this repository, change directories to project working directory, then setup and activate the virtual enviroment:

git clone REPOSITORY_URL_GOES_HERE
cd sktimeline
virtualenv --no-site-packages .
source bin/activate

Downgrade to pip v8.1.1 and install pip-tools: (note: this is currently needed for pip-tools as used to manage packages)

bin/pip install --upgrade pip==8.1.1
bin/pip install pip-tools

Install needed project packages from requirements.txt in the virtualenv via pip-sync:

bin/pip-sync

Setup the Flask application server

bin/python run.py

Done!

I've setup this project to use the requirements.in file to manage all packages that is needed for development.

If a new package is needed, add it to the requirements.in file then run bin/pip-compile. This generates the requirements.txt file which locks the package to a version.

When upgrading a code change from the repo that requires a new package to be d, run bin/pip-sync which will install/upgrade/uninstall everything so that the virtualenv exactly matches what's in requirements.txt file.