wall_e_api

Provides the endpoints for wall_e's website

• 1. Setup Python Environment
• 2. Setup and Run Website
• 3. Before opening a PR
• Various tasks to accomplish

1. Setup Python Environment

for Debian based OS

sudo apt-get install -y python3.9
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python3.7 get-pip.py --user
python3.7 -m pip install virtualenv --user
python3.7 -m virtualenv wall_e_api
. wall_e_api/bin/activate

for MacOS

https://www.python.org/downloads/release/python-3913/

python3.9 -m pip install --upgrade pip
python3.9 -m pip install virtualenv
python3.9 -m virtualenv walle
. walle/bin/activate

for Windows

open to anyone to make a PR adding this section

2. Setup and Run Website

If you hve not cloned your forked version yet
wget https://raw.githubusercontent.com/CSSS/wall_e_api/master/download_repo.sh
./download_repo.sh

If you have forked your version
./run_site.sh

2.1 To make any needed changes to the models

python -m pip uninstall wall_e_models

git clone https://github.com/CSSS/wall_e_models.git
cd wall_e_models
# make any necessary changes

# package model
python3 setup.py sdist

# install package for wall_e
python -m pip install ../wall_e_models/dist/wall_e_models-0.X.tar.gz