PyTransportNSWv2 0.5.6__tar.gz → 0.6.0__tar.gz

{PyTransportNSWv2-0.5.6 → PyTransportNSWv2-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyTransportNSWv2
-Version: 0.5.6
+Version: 0.6.0
 Summary: Get detailed per-trip transport information from TransportNSW
 Home-page: https://github.com/andystewart999/TransportNSW
 Author: andystewart999
@@ -24,7 +24,21 @@ Description: # TransportNSWv2
         
         ### Parameters
         ```python
-        .get_trip(origin_stop_id, destination_stop_id, api_key, [trip_wait_time = 0], [transport_type = 0])
+        .get_trip(origin_stop_id, destination_stop_id, api_key, [trip_wait_time = 0], [transport_type = 0], [strict_transport_type = True|False], [raw_output = True|False], [journeys_to_return = 1] )
+        ```
+        
+        Transport types:
+        ```
+        1: Train
+        2: Metro
+        4: Light rail
+        5: Bus
+        7: Coach
+        9: Ferry
+        11: School bus
+        99: Walk
+        100: Walk
+        107: Cycle
         ```
         
         TransportNSW's trip planner can work better if you use the general location IDs (eg Central Station) rather than a specific Stop ID (eg Central Station, Platform 19) for the destination, depending on the transport type.  Forcing a specific end destination sometimes results in much more complicated trips.  Also note that the API expects (and returns) the Stop IDs as strings, although so far they all appear to be numeric.
@@ -62,7 +76,7 @@ Description: # TransportNSWv2
         * latitude & longitude: The location of the vehicle, if available
         
         Please note that the origin and destination detail is just that - information about the first and last stops on the journey at the time the request was made.  We don't return any intermediate steps, transport change types etc other than the total number of changes - the assumption is that you'll know the details of your specified trip, you just want to know when the next departure is.  If you need much more detailed information then I recommend that you use the full Transport NSW trip planner website or application.
-        Also note that the 'transport_type' filter, if present,  only makes sure that at least one leg of the journey includes that transport type.
+        Also note that the 'transport_type' filter, if present,  only makes sure that at least one leg of the journey includes that transport type unless 'strict_transport_type' is True, in which case the first leg MUST be of the requested type to be returned.
         
         ## Thank you
         Thank you Dav0815 for your TransportNSW library that the vast majority of this fork is based on.  I couldn't have done it without you!

{PyTransportNSWv2-0.5.6 → PyTransportNSWv2-0.6.0}/PyTransportNSWv2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyTransportNSWv2
-Version: 0.5.6
+Version: 0.6.0
 Summary: Get detailed per-trip transport information from TransportNSW
 Home-page: https://github.com/andystewart999/TransportNSW
 Author: andystewart999
@@ -24,7 +24,21 @@ Description: # TransportNSWv2
         
         ### Parameters
         ```python
-        .get_trip(origin_stop_id, destination_stop_id, api_key, [trip_wait_time = 0], [transport_type = 0])
+        .get_trip(origin_stop_id, destination_stop_id, api_key, [trip_wait_time = 0], [transport_type = 0], [strict_transport_type = True|False], [raw_output = True|False], [journeys_to_return = 1] )
+        ```
+        
+        Transport types:
+        ```
+        1: Train
+        2: Metro
+        4: Light rail
+        5: Bus
+        7: Coach
+        9: Ferry
+        11: School bus
+        99: Walk
+        100: Walk
+        107: Cycle
         ```
         
         TransportNSW's trip planner can work better if you use the general location IDs (eg Central Station) rather than a specific Stop ID (eg Central Station, Platform 19) for the destination, depending on the transport type.  Forcing a specific end destination sometimes results in much more complicated trips.  Also note that the API expects (and returns) the Stop IDs as strings, although so far they all appear to be numeric.
@@ -62,7 +76,7 @@ Description: # TransportNSWv2
         * latitude & longitude: The location of the vehicle, if available
         
         Please note that the origin and destination detail is just that - information about the first and last stops on the journey at the time the request was made.  We don't return any intermediate steps, transport change types etc other than the total number of changes - the assumption is that you'll know the details of your specified trip, you just want to know when the next departure is.  If you need much more detailed information then I recommend that you use the full Transport NSW trip planner website or application.
-        Also note that the 'transport_type' filter, if present,  only makes sure that at least one leg of the journey includes that transport type.
+        Also note that the 'transport_type' filter, if present,  only makes sure that at least one leg of the journey includes that transport type unless 'strict_transport_type' is True, in which case the first leg MUST be of the requested type to be returned.
         
         ## Thank you
         Thank you Dav0815 for your TransportNSW library that the vast majority of this fork is based on.  I couldn't have done it without you!

{PyTransportNSWv2-0.5.6 → PyTransportNSWv2-0.6.0}/README.md

@@ -17,7 +17,21 @@ The source API details can be found here: https://opendata.transport.nsw.gov.au/
 
 ### Parameters
 ```python
-.get_trip(origin_stop_id, destination_stop_id, api_key, [trip_wait_time = 0], [transport_type = 0])
+.get_trip(origin_stop_id, destination_stop_id, api_key, [trip_wait_time = 0], [transport_type = 0], [strict_transport_type = True|False], [raw_output = True|False], [journeys_to_return = 1] )
+```
+
+Transport types:
+```
+1: Train
+2: Metro
+4: Light rail
+5: Bus
+7: Coach
+9: Ferry
+11: School bus
+99: Walk
+100: Walk
+107: Cycle
 ```
 
 TransportNSW's trip planner can work better if you use the general location IDs (eg Central Station) rather than a specific Stop ID (eg Central Station, Platform 19) for the destination, depending on the transport type.  Forcing a specific end destination sometimes results in much more complicated trips.  Also note that the API expects (and returns) the Stop IDs as strings, although so far they all appear to be numeric.
@@ -55,7 +69,7 @@ Fun fact:  TransportNSW's raw API output calls itself JSON, but it uses single q
 * latitude & longitude: The location of the vehicle, if available
 
 Please note that the origin and destination detail is just that - information about the first and last stops on the journey at the time the request was made.  We don't return any intermediate steps, transport change types etc other than the total number of changes - the assumption is that you'll know the details of your specified trip, you just want to know when the next departure is.  If you need much more detailed information then I recommend that you use the full Transport NSW trip planner website or application.
-Also note that the 'transport_type' filter, if present,  only makes sure that at least one leg of the journey includes that transport type.
+Also note that the 'transport_type' filter, if present,  only makes sure that at least one leg of the journey includes that transport type unless 'strict_transport_type' is True, in which case the first leg MUST be of the requested type to be returned.
 
 ## Thank you
 Thank you Dav0815 for your TransportNSW library that the vast majority of this fork is based on.  I couldn't have done it without you!

{PyTransportNSWv2-0.5.6 → PyTransportNSWv2-0.6.0}/TransportNSWv2/TransportNSWv2.py

@@ -178,8 +178,8 @@ class TransportNSWv2(object):
                 destination_arrival_time = destination['arrivalTimeEstimated']
 
                 # Origin type info - train, bus, etc
-                origin_mode_temp = transportation['product']['class']
-                origin_mode = self.get_mode(origin_mode_temp)
+                #origin_mode_temp = transportation['product']['class']
+                origin_mode = self.get_mode(transportation['product']['class'])
                 origin_mode_name = transportation['product']['name']
 
                 # RealTimeTripID info so we can try and get the current location later
@@ -209,79 +209,75 @@ class TransportNSWv2(object):
                 longitude = 'n/a'
 
                 if realtimetripid != 'n/a':
-                    # Build the URL
-                    url = \
-                        'https://api.transport.nsw.gov.au/v1/gtfs/vehiclepos' \
-                        + self.get_url(origin_mode)
-                    auth = 'apikey ' + self.api_key
-                    header = {'Authorization': auth}
-
-                    response = requests.get(url, headers=header, timeout=10)
-                    # Only try and process the results if we got a good return code
-                    if response.status_code == 200:
-                        # Search the feed and see if we can find the trip_id
-                        # If we do, capture the latitude and longitude
-                        feed = gtfs_realtime_pb2.FeedMessage()
-                        feed.ParseFromString(response.content)
-
-                        # Unfortunately we need to do some mucking about for train-based trip_ids
-                        # Define the appropriate regular expression to search for - usually just the full text
-                        bFindLocation = True
-
-                        if origin_mode == 'Train':
-                            triparray = realtimetripid.split('.')
-                            if len(triparray) == 7:
-                                trip_id_wild = triparray[0] + '.' + triparray[1] + '.' + triparray[2] + '.+.' + triparray[4] + '.' + triparray[5] + '.' + triparray[6]
-                            else:
-                                # Hmm, it's not the right length (this happens rarely) - give up
-                                bFindLocation = False
-                        else:
-                            trip_id_wild = realtimetripid
-
-                        if bFindLocation:
-                            reg = re.compile(trip_id_wild)
+                    # Build the URL(s) - some modes have multiple GTFS sources, unforunately
+                    url_path = self.get_url(origin_mode)
+                    url_list = self.get_url_path(origin_mode)
+                    bFoundTripID = False
+
+                    for mode_url in url_list:
+                        url = url_path + mode_url
+                        auth = 'apikey ' + self.api_key
+                        header = {'Authorization': auth}
+
+                        response = requests.get(url, headers=header, timeout=10)
+
+                        # Only try and process the results if we got a good return code
+                        if response.status_code == 200:
+                            # Search the feed and see if we can match realtimetripid to trip_id
+                            # If we do, capture the latitude and longitude
+                            feed = gtfs_realtime_pb2.FeedMessage()
+                            feed.ParseFromString(response.content)
+
+                            reg = re.compile(realtimetripid)
 
                             for entity in feed.entity:
                                 if bool(re.match(reg, entity.vehicle.trip.trip_id)):
                                     latitude = entity.vehicle.position.latitude
                                     longitude = entity.vehicle.position.longitude
-                                    # We found it, so break out
+
+                                    # We found it, so flag it and break out
+                                    bFoundTripID = True
                                     break
 
-                    self.info = {
-                        ATTR_DUE_IN: due,
-                        ATTR_ORIGIN_STOP_ID : origin_stop_id,
-                        ATTR_ORIGIN_NAME : origin_name,
-                        ATTR_DEPARTURE_TIME : origin_departure_time,
-                        ATTR_DESTINATION_STOP_ID : destination_stop_id,
-                        ATTR_DESTINATION_NAME : destination_name,
-                        ATTR_ARRIVAL_TIME : destination_arrival_time,
-                        ATTR_ORIGIN_TRANSPORT_TYPE : origin_mode,
-                        ATTR_ORIGIN_TRANSPORT_NAME: origin_mode_name,
-                        ATTR_ORIGIN_LINE_NAME : origin_line_name,
-                        ATTR_ORIGIN_LINE_NAME_SHORT : origin_line_name_short,
-                        ATTR_CHANGES: changes,
-                        ATTR_OCCUPANCY : occupancy,
-                        ATTR_REAL_TIME_TRIP_ID : realtimetripid,
-                        ATTR_LATITUDE : latitude,
-                        ATTR_LONGITUDE : longitude
-                        }
-
-                    found_journeys = found_journeys + 1
-
-                    # Add to the return array
-                    if (no_valid_journeys == True):
-                        break
-
-                    if (found_journeys >= 2):
-                        json_output = json_output + ',' + json.dumps(self.info)
-                    else:
-                        json_output = json_output + json.dumps(self.info)
-
-                    if (found_journeys == journeys_to_return):
-                        break
-
-                    current_journey_index = next_journey_index
+                        if bFoundTripID == True:
+                            # No need to look any further
+                            break
+
+
+                self.info = {
+                    ATTR_DUE_IN: due,
+                    ATTR_ORIGIN_STOP_ID : origin_stop_id,
+                    ATTR_ORIGIN_NAME : origin_name,
+                    ATTR_DEPARTURE_TIME : origin_departure_time,
+                    ATTR_DESTINATION_STOP_ID : destination_stop_id,
+                    ATTR_DESTINATION_NAME : destination_name,
+                    ATTR_ARRIVAL_TIME : destination_arrival_time,
+                    ATTR_ORIGIN_TRANSPORT_TYPE : origin_mode,
+                    ATTR_ORIGIN_TRANSPORT_NAME: origin_mode_name,
+                    ATTR_ORIGIN_LINE_NAME : origin_line_name,
+                    ATTR_ORIGIN_LINE_NAME_SHORT : origin_line_name_short,
+                    ATTR_CHANGES: changes,
+                    ATTR_OCCUPANCY : occupancy,
+                    ATTR_REAL_TIME_TRIP_ID : realtimetripid,
+                    ATTR_LATITUDE : latitude,
+                    ATTR_LONGITUDE : longitude
+                    }
+
+                found_journeys = found_journeys + 1
+
+                # Add to the return array
+                if (no_valid_journeys == True):
+                    break
+
+                if (found_journeys >= 2):
+                    json_output = json_output + ',' + json.dumps(self.info)
+                else:
+                    json_output = json_output + json.dumps(self.info)
+
+                if (found_journeys == journeys_to_return):
+                    break
+
+                current_journey_index = next_journey_index
 
         json_output='{"journeys_to_return": ' + str(self.journeys_to_return) + ', "journeys_with_data": ' + str(found_journeys) + ', "journeys": [' + json_output + ']}'
         return json_output
@@ -378,6 +374,7 @@ class TransportNSWv2(object):
         """Map the iconId to a full text string"""
         modes = {
             1: "Train",
+            2: "Metro",
             4: "Light rail",
             5: "Bus",
             7: "Coach",
@@ -389,17 +386,35 @@ class TransportNSWv2(object):
         }
         return modes.get(iconId, None)
 
-
     def get_url(self, mode):
-        """Map the journey mode to the proper real time location URL """
+        """Map the journey mode to the proper base real time location URL """
+        v1_url = "https://api.transport.nsw.gov.au/v1/gtfs/vehiclepos"
+        v2_url = "https://api.transport.nsw.gov.au/v2/gtfs/vehiclepos"
+
+        url_options = {
+            "Train":      v2_url,
+            "Metro":      v2_url,
+            "Light rail": v1_url,
+            "Bus":        v1_url,
+            "Coach":      v1_url,
+            "Ferry":      v1_url,
+            "School bus": v1_url
+        }
+        return url_options.get(mode, None)
+
+
+    def get_url_path(self, mode):
+        """Map the journey mode to the proper modifier URL """
+        bus_list = ["/buses", "/regionbuses/centralwestandorana", "/regionbuses/centralwestandorana2", "/regionbuses/newenglandnorthwest", "/regionbuses/northcoast", "/regionbuses/northcoast2", "/regionbuses/northcoast3", "/regionbuses/riverinamurray", "/regionbuses/riverinamurray2", "/regionbuses/southeasttablelands", "/regionbuses/southeasttablelands2", "/regionbuses/sydneysurrounds", "/regionbuses/newcastlehunter", "/regionbuses/farwest"]
 
         url_options = {
-            "Train"      : "/sydneytrains",
-            "Light rail" : "/lightrail/innerwest",
-            "Bus"        : "/buses",
-            "Coach"      : "/buses",
-            "Ferry"      : "/ferries/sydneyferries",
-            "School bus" : "/buses"
+            "Train"      : ["/sydneytrains"],
+            "Metro"      : ["/metro"],
+            "Light rail" : ["/lightrail/innerwest", "/lightrail/cbdandsoutheast", "/lightrail/newcastle"],
+            "Bus"        : bus_list,
+            "Coach"      : bus_list,
+            "Ferry"      : ["/ferries/sydneyferries"],
+            "School bus" : bus_list
         }
         return url_options.get(mode, None)
 

{PyTransportNSWv2-0.5.6 → PyTransportNSWv2-0.6.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="PyTransportNSWv2",
-    version="0.5.6",
+    version="0.6.0",
     author="andystewart999",
     description="Get detailed per-trip transport information from TransportNSW",
     long_description=long_description,