pittcsc/pittapiwebwrapper

The Flask web app for REST endpoints for the PittAPI

Web Wrapper for PittAPI

Installation

1. Clone this repo
2. Create a virtual environment virtualenv venv and enable it. source venv/bin/activate
3. Run pip install -r requirements.txt to install dependencies.
4. Launch python server.py to run the server.

API Endpoints

Courses

/courses/<term>/<code>

Classes

/class/<class_number>/<term>

Lab Status

/lab_status/<lab_name>

Laundry Status

For simple laundry status:

/laundry/simple/<location>

For detailed laundry status:

/laundry/detailed/<location>

People

/people/<query>

Shuttles

For shuttle routes:

/shuttle/routes

For shuttle vehicle points:

/shuttle/points

For shuttle arrivals:

/shuttle/arrivals/<times_per_stop>

For shuttle stop estimates:

/shuttle/estimates/<vehicle_id>/<quantity>

Textbooks

If the term is to be specified:

/textbook/<department_code>/<course_name>/<instructor>/<term>

If the term is not to be specified:

/textbook/<department_code>/<course_name>/<instructor>

News

/news/<feed>/<max_news_items>

License

Web Wrapper for PittAPI, web app for REST endpoints for the PittAPI
Copyright (C) 2015 Ritwik Gupta

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

pittapiwebwrapper's Issues

Flask returns invalid JSON

Looks like the endpoints convert PIttAPI responses to strings, but JSON can't parse it back to JSON.

Set proper headers

Currently the calls are missing a lot of proper, standard headers. Please include proper CORS and cache headers.

Tests

Write tests for the endpoints to ensure they are all returning 200 with proper JSON output

No permissions to clone subdirectory

https://hastebin.com/yiwojakoke.pl

Says I can't clone the sub module because I don't have correct access rights. Can I just clone the PittAPI repo separately into the apiwrapper directory, or is there a specific version that I need?