webqueue2 API

A Python based parser and RESTful API for ECN's webqueue.

Docs

See https://pages.github.itap.purdue.edu/ECN/webqueue2-api/

Installation

Create virtual environment named venv

python3 -m venv __venv__

Active virtual environment

source __venv__/bin/activate

Update pip

pip install -U pip

Install package

pip install git+https://github.itap.purdue.edu/ECN/webqueue2-api@1.1.0#egg=webqueue2api

Parser Usage

Load a queue and get the number of items in it.

import webqueue2api
ce_queue = webqueue2api.Queue("ce")
print( len( ce_queue.items ) )

# Expected Output
29

Load an item and get its subject.

import webqueue2api
ce_1 = webqueue2api.Item("ce", 1)
print( len( ce_1.subject ) )

# Expected Output
"Re: Battery Replacement"

API Usage

Start the API in the background

gunicorn --daemon webqueue2api.api:app

Login (replace bob and super_secret with your career account credentials.)

curl -X POST \
    -H "Content-Type: application/json" \
    -d '{"username": "bob", "password": "super_secret"}' \
    localhost:8000/api/login

# Expected Output
{"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MjUxMTc4OTAsIm5iZiI6MTYyNTExNzg5MCwianRpIjoiMzZhODYzYmEtNmFhNS00NDc1LTk5NmYtMjhjMTcxZTc4N2M5IiwiZXhwIjoxNjI1MTE4NzkwLCJzdWIiOiJjYW1wYjMwMyIsImZyZXNoIjpmYWxzZSwidHlwZSI6ImFjY2VzcyIsImNzcmYiOiJkZDA4NmYzMi1lYTEwLTQxNmYtODg3NS1iZTFjZDkwZjkwMTAifQ.SEf_oTxr5vtvMndGtHo9By51LBgAWEQAVcX_N5t0twA"}

Contributing

Clone the git repo:

git clone https://github.itap.purdue.edu/ECN/webqueue2-api.git

Create and activate Python virtual environment:

python3 -m venv venv
source venv/bin/activate

Install dependencies:

# Older versions of pip may fail to install newer packages.
pip install -U pip
# Install the webqueue2-api package in editable mode with all extra packages.
pip install -e .[all]

Make changes and create a PR.

ECN/webqueue2-api

About

Resources

Stars

Watchers

Forks

Releases 4

Contributors 2

Languages