IEAutoReviewBot

http://ieautoreview-scoli.pythonanywhere.com/

Environment Setup

This tool is created and tested using Python 3.11.

---

Using github codespaces

Click the button above, wait for the environment to be created

The manual way

Create and enable the virtual environment, and install the required packages.

Note that coloredlogs is commented in mysite/requirements.txt, as it doesn't work with the PythonAnywhere site. It's still needed for dev work though, so make sure it gets installed too, by uncommenting it.

Preferably create the virtual environment somewhere under the project root. make test command doesn't account for virtual environments located outside project scope

Unix/MacOS:

venv_dir="<venv/dir/name/here>"
python -m venv "$venv_dir"
source "$venv_dir"/bin/activate
pip install --upgrade pip setuptools wheel
pip install -r mysite/requirements/dev.txt

Windows:

$venv_dir = "<venv/dir/name/here>"
python -m venv "$venv_dir"
"$venv_dir"/Scripts/Activate.ps1
pip install --upgrade pip setuptools wheel
pip install -r mysite/requirements/dev.txt

---

Run

Using github codespaces

Hit Ctrl+Maj+D or navigate to the debug tab, and run the included config. A popup will give you a link to the now hosted app

The manual way

To run the app, run:

Unix/MacOS:

cd mysite
export PYTHONUNBUFFERED=1
export FLASK_APP=flask_app:app
export FLASK_ENV=development
export FLASK_RUN_PORT=5000
python -m flask run 

Windows:

cd mysite
$env:PYTHONUNBUFFERED = 1
$env:FLASK_APP = "flask_app:app"
$env:FLASK_ENV = "development"
$env:FLASK_RUN_PORT = 5000
python -m flask run 

or, if you're using PyCharm, run one of the two saved run configurations.

---

Test

To run tests, run:

cd mysite
pytest -p no:warnings

or, using make:

cd mysite
make test