Update installation readme (#278)

* Split up setup / install

* Update contributing guide

* Skip java and hadoop

Author: nlathia

CONTRIBUTING.md

@@ -23,29 +23,31 @@ To contribute to `modelstore`'s code base, we recommend taking the following jou
 
 ## 👨🏽‍💻 Get familiar with the code base
 
+### Pre-requisitings
+
+This library has been developed on Mac OS. To get started:
+
+```bash
+❯ make setup
+```
+
+Will update `brew`, install `pyenv` and other things an required by ML libraries (e.g `libomp`, required by `xgboost`).
+
 ### Setup a virtual environment
 
-This library has been developed using [pyenv](https://github.com/pyenv/pyenv)
-and [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), using the
-requirements that are in `requirements.txt` and `requirements-dev.txt`.
+This library has been developed using [pyenv](https://github.com/pyenv/pyenv) and [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), using the requirements that are in `requirements.txt` and `requirements-dev.txt`.
 
-This project has two requirements files:
+This project has two types of requirements files:
 * `requirements.txt` contains any dependencies that `modelstore` users must have in order to use `modelstore`. This should be as lightweight as possible. We do not require users to install every single machine learning library - just the ones that they want to use.
-* `requirements-dev.txt` contains all of the dependencies that `modelstore` developers must have. This file does contain all of the machine learning frameworks that are supported by `modelstore` - they must be installed to enable running all of the unit tests. 
+* `requirements-dev[X].txt` contains all of the dependencies that `modelstore` developers must have. These files contain all of the machine learning frameworks that are supported by `modelstore` - they must be installed to enable running all of the unit tests. 
 
-You can create a virtual environment using your favourite approach and
-install all of those dependencies, or once you have set up `pyenv`, use this
- `Makefile` command that does the rest for you:
+Once you have set up `pyenv` and `pyenv-virtualenv` installed, use this `Makefile` command that does the rest for you:
 
 ```bash
 ❯ make install
 ```
 
-Will update `brew` and install `libomp` (required by `xgboost`).
-
-It will then create a Python virtual environment, using `pyenv-virtualenv`,
-and install all of the dependencies in the requirements files. If you want
-to use a different version of Python, update the [bin/_config](bin/config) file.
+This will create a Python virtual environment, using `pyenv-virtualenv`, and install all of the dependencies in the requirements files. If you want to use a different version of Python, update the [bin/_config](bin/config) file.
 
 Notes:
 * I've seen trouble with installing `prophet` and have sometimes had to install it manually
@@ -74,7 +76,6 @@ For details, head over to the [README.md](examples/README.md) in the `examples`
 
 All of `modelstore`'s bugs are publicly tracked via [Github issues](https://github.com/operatorai/modelstore/issues). 
 
-
 ## 💡 Contribute new feature ideas
 
 There are a variety of ideas that have been listed in the repo's [discussions](https://github.com/operatorai/modelstore/discussions) section. For example:

Makefile

@@ -1,12 +1,14 @@
 VIRTUALENV_NAME=$(shell pwd | rev | cut -d '/' -f 1 | rev)-dev
 
-.PHONY: library test install uninstall release-test release-prod clean update
+.PHONY: library test setup install uninstall release-test release-prod clean update
 
 uninstall:
 	@./bin/_pyenv_uninstall $(VIRTUALENV_NAME)
 
+setup:
+	@./bin/_brew_install
+
 install: uninstall
-	#@./bin/_brew_install
 	@./bin/_pyenv_install $(VIRTUALENV_NAME)
 
 update:

bin/_brew_install

@@ -1,25 +1,37 @@
 #!/bin/bash
 set -e
 
-echo "\n ⏱  Running brew update and installing libomp"
+function install {
+    if brew ls --versions "$1" >/dev/null; then
+        HOMEBREW_NO_AUTO_UPDATE=1 brew upgrade "$1"
+    else
+        HOMEBREW_NO_AUTO_UPDATE=1 brew install "$1"
+    fi
+}
+
+echo -e "\n 💬  Running brew update..."
 brew update
 
+echo -e "\n 💬  Installing pyenv & pyenv-virtualenv..."
+install pyenv
+install pyenv-virtualenv
+
 # To get pystan to install correctly (required by prophet)
 # https://stackoverflow.com/questions/52814868/pystan-compileerror-command-gcc-failed-with-exit-status-1-macos
-brew install gcc
+echo -e "\n 💬  Installing gcc..."
+install gcc
 export CC=gcc-11
 export CXX=g++-11
 
 # To use xgboost models on mac
 # https://xgboost.readthedocs.io/en/latest/build.html#building-on-osx
-# Note: it looks like there's trouble with libomp 12
-# https://github.com/dmlc/xgboost/issues/7039
-brew install rajivshah3/libomp-tap/libomp@11.1.0
+echo -e "\n 💬  Installing libomp..."
+install libomp
 
 # To use pyspark models on mac
-brew install java
-
 # To use hdfs storage on mac
-brew install hadoop
+# echo -e "\n 💬  Installing java and hadoop..."
+# install java
+# install hadoop
 
 echo "\n ✅  Done."