Smooth out development environment setup

.gitignore

@@ -16,3 +16,5 @@ eggs/
 *.egg
 TODO.md
 spot/benchmarks/*/workload.json
+
+spot-env/

README.md

@@ -3,15 +3,30 @@ Created by Capstone Group 59
 
 ## Setup
 
-- Clone the repository
-- Change your current directory to the root directory of the repository
-- Install the repository as a package
+### Requirements
+- Python 3
+- AWS CLI (configured with `aws configure`)
+- MongoDB (by default, accessible on `localhost:27017`)
 
-  ```bash
-  pip install -e .
-  ```
-- Run spot/main.py
+### Steps
+1. Create and activate a virtualenv.
+```bash
+python3 -m venv spot-env
+source spot-env/bin/activate
+```
+
+2. Install required packages.
+```
+pip install -r requirements.txt
+```
+
+3. Install SPOT as an editable package.
+```bash
+pip install -e .
+```
+
+4. Run it!
+```bash
+spot
+```
 
-  ```bash
-  python3 spot/main.py
-  ```

requirements.txt

@@ -0,0 +1,7 @@
+pandas==1.4.0
+pymongo==4.0.1
+matplotlib==3.5.1
+requests==2.27.1
+requests_futures==1.0.0
+boto3==1.20.44
+sklearn

setup.py

@@ -12,6 +12,9 @@
       },
       install_requires=[],
       extras_require={},
+      entry_points={
+          'console_scripts': ['spot=spot.main:main']
+          },
       description='Serverless Price Optimization Tool',
       version='0.0.1'
       )