pyWMATA

A python library for accessing the WMATA API for Washington DC Metro. ##Usage

  apikey = '' ###API keys available here https://developer.wmata.com/

  api = pyWMATA.WMATA(apikey)

===== To get departure times for a given stationcode

  stationcode = 'F01' #Gallery place metro

  times = api.getTrainDepartures(stationcode)

Returns a list of times until train departures from the given station.

===== To get departure times for a given stationcode in a certain direction

  stationcode = 'F01' #Gallery place metro
  
  times = api.getTrainDepartures(stationcode, 'Huntington', 'Franconia-Springfield')

Returns a list of times until train departures from the given station in the given direction.

===== To get travel time needed to travel from one station to another

  startStationCode = 'F01' #Gallery place metro
  endStationCode = 'A04' #Woodley Park metro
  
  totalTravelTime = getTravelTime(self, startStationCode, endStationCode)

Returns an integer that is the total time needed to go from one station to the next.

===== To get a path from one station to another

  startStationCode = 'F01' #Gallery place metro
  startStationName = 'Gallery Place'
  
  endStationCode = 'A04' #Woodley Park metro
  endStationName = 'Woodley'
  
  stopsAlongPath = getPath(startStationCode, endStationCode)
  stopsAlongPath = getPath(startStationName, endStationName)

Returns a list of station names along the path with transfers specified by (Transfer towards $station)

==== To get a human readable path from one station to another

  startStationCode = 'F01' #Gallery place metro
  startStationName = 'Gallery Place'
  
  endStationCode = 'A04' #Woodley Park metro
  endStationName = 'Woodley'
  
  pathDescription = getPathHumanReadable(startStationCode, endStationCode)
  pathDescription = getPathHumanReadable(startStationName, endStationName)

Returns a string that is a human readable description of the path including transfer directions.

==== To get a station code for a given station

  stationName = 'Woodley'
  
  stationCode = getStationcode(stationName)

Returns either a station code or None.

==== To get a station name for a given station code

  stationCode = 'A04'
  
  stationName = getStationName(stationCode)

Returns either a station name or None.

==== To get a station close to a location

  lat = '38.8522750'
  lon = '-77.0423126'
  
  nearestStationCode = getNearestStation(lat, lon)

Returns the closest stationcode to the supplied location.

==== To check if their is an escalator or elevator problem at a station

  stationCode = 'C13'
  
  elevatorsAndEscalatorsIncident = getElevatorEscalatorIncidentsAtStation(stationCode)

Returns True if there is an elevator or escalator outage and False if there is not.

==== To get the direction of the train you need to take between two stations

  startStationCode = 'F01'
  endStationCode = 'C13'
  
  possibleDirections = getDirections(startStationCode, endStationCode)

Returns an array of the possible directions you can take.