PittAPI 0.1.1

An API to get data from Pitt and Pitt-related applications.

# Pitt API
[](https://travis-ci.org/Pitt-CSC/PittAPI)
[](LICENSE)

Made by Ritwik Gupta at the University of Pittsburgh in an effort to get more open data from Pitt.

## Usage examples

```python
from PittAPI import course, laundry, lab, dining

### Courses
# Will return a list of dictionaries containing courses in subject
big_dict = course.get_courses(term="2177", code="CS")
# Will return a list of dictionaries containing courses that fulfill requirement
big_dict = course.get_course(term="2177", code="Q")
# Will return a dictionary with a details about the class
description = course.get_class(term="2177", class_number="10163")

### Laundry
# Will return a dictionary with amount of washers and dryers
# in use vs. total washers and dryers at building
small_dict = laundry.get_status_simple(building_name="TOWERS")

### Computer Lab
# Will return a dictionary with status of the lab, and amount
# of machines with a certain OS
small_dict = lab.get_status(lab_name="ALUMNI")

### Dining
# Will return a dictionary of dictionaries containing each dining location,
# with its name, its open/closed status, and open times (if it exists)
medium_dict = dining.get_locations()
medium_dict = dining.get_locations_by_status(status="open")
medium_dict = dining.get_locations_by_status(status="closed")
# Will return a single dictionary of a dining location,
# with its name, its open/closed status, and open times (if it exists)
one = dining.get_location_by_name(u"taco_bell-schenley_cafe")
two = dining.get_location_by_name(u"cup_&_chaucer-hillman")
```

## Tests
Run tests with `python3 -m "nose" --with-coverage --cov PittAPI/ --with-timer tests/*`.
If your `python -v` is 3+, replace `python3` with `python`.

## TODO
* [x] Make the laundry detailed method work
* [x] Test the computer lab status API and make it return a dictionary
* [ ] Working on the DiningAPI
* [x] Have the DiningAPI return a dict instead of a list
* [x] Have a separate method for `get_locations_by_status` and `get_locations`
* [x] `get_locations_by_status` is what is currently implemented
* [x] `get_locations` is the same as what is currently implemented with no arguments
* [x] but with a good-looking dictionary
* [x] Implement the `get_location_by_name` method
* [ ] Implement the `get_location_menu` method
* [x] Implement the helper methods `_encode_location` and `_decode_location`
* [x] Change all string processing to unicode (dropped Py2.7 support, fixed :smile:)

## License

This project is licensed under the terms of the [GPLv2 license](LICENSE).