Skip to content

Commit

Permalink
Added installation instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
jessexoc committed Jun 6, 2015
1 parent af7b5c8 commit 569400f
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
A Python client for Public Transport Victoria's Timetable API: https://www.data.vic.gov.au/data/dataset/ptv-timetable-api .
This is not just a wrapper sending off reqests to the API and returning json. It encapsulates the API responses into classes that can be further interacted with.

# Installation

pip install git+https://github.com/jessexoc/pyptv.git

# Features
- Returned objects are presented as classes (eg TramStop, BusLine, RetailOutlet)
- Methods on classes that simplify subsequent calls (eg `TramStop.broad_next_departures()` vs `client.broad_next_departures(TramStop.mode, TramStop.stop_id)`)
Expand Down

0 comments on commit 569400f

Please sign in to comment.