Installation⚓︎
The webqueue2 API is publicly available at https://engineering.purdue.edu/webqueue/webqueue2/build/api but you can install it on your own machine if you'd like.
The code is available on GitHub. Available package versions can be seen on the releases page and can be installed via pip, a requirements file, or downloaded and installed manually.
pip available on ECN machines needs updated.
Installation via pip is possible through pip's VCS support which was introduced in pip 19. The version of pip available on ECN supported machines is too old and needs updated. To update pip, run:
pip install -U pop
Using a virtual environment is recommended for reproducibility.
Create a virtual environment called __venv__:
python3 -m venv __venv__
Activate the virtual environment:
source __venv__/bin/activate
Update pip:
pip install -U pip
To install webqueue2-api 1.0.0, you can run:
pip install git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api
To install webqueue2-api 1.0.0, place the following line your requirements file:
echo "git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.0.0#egg=webqueue2api" >> requirements.txt
pip install -r requirements.txt
If you'd like a version other than 1.0.0 simply replace the that version number with a different version listed on the releases page.
To start the server, run the following while your virtual environment is activated:
gunicorn webqueue2api.api:app