Git Product home page Git Product logo

pittapi's Introduction

Pitt API

Build Status License GPLv2 Python 3.4, 3.5

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

Usage examples

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

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

License

This project is licensed under the terms of the GPLv2 license.

pittapi's People

Contributors

ritwikgupta avatar dzheng256 avatar rahi374 avatar ethanwelsh avatar adrienac avatar rchatrath7 avatar johnlinahan avatar omribarak avatar timparenti avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.