PyTransportNSWv2 0.6.0__tar.gz → 0.6.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyTransportNSWv2
-Version: 0.6.0
+Version: 0.6.5
 Summary: Get detailed per-trip transport information from TransportNSW
 Home-page: https://github.com/andystewart999/TransportNSW
 Author: andystewart999
@@ -15,7 +15,7 @@ Description: # TransportNSWv2
         https://opendata.transport.nsw.gov.au/user-guide.  You need to register an application that needs both the Trip Planner and Realtime Vehicle Positions APIs
         
         ### Get the stop IDs
-        The function needs the stop IDs for the source and destination, and optionally how many minutes from now the departure should be, and if you want to filter trips by a specific transport type.  The easiest way to get the stop ID is via https://transportnsw.info/stops#/. It provides the option to search for either a location or a specific platform, bus stop or ferry wharf.  Regardless of if you specify a general location for the origin or destination, the return information shows the stop_id for the actual arrival and destination platform, bus stop or ferry wharf.
+        The function needs the stop IDs for the source and destination, and optionally how many minutes from now the departure should be, and if you want to filter trips by a specific transport type, or to only include trips that have specific text somewhere in the line/service details (see below).  The easiest way to get the stop ID is via https://transportnsw.info/stops#/. It provides the option to search for either a location or a specific platform, bus stop or ferry wharf.  Regardless of if you specify a general location for the origin or destination, the return information shows the stop_id for the actual arrival and destination platform, bus stop or ferry wharf.
         
         If it's available, the general occupancy level and the latitude and longitude of the selected journey's vehicle (train, bus, etc) will be returned.
         
@@ -24,7 +24,7 @@ Description: # TransportNSWv2
         
         ### Parameters
         ```python
-        .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] )
+        .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], [route_filter = ''] )
         ```
         
         Transport types:
@@ -58,6 +58,9 @@ Description: # TransportNSWv2
         ```python
         {"due": 3, "origin_stop_id": "207537", "origin_name": "Mona Vale Rd at Shinfield Ave, St Ives", "departure_time": "2024-05-20T21:59:48Z", "destination_stop_id": "2000338", "destination_name": "Central Station, Platform 18, Sydney", "arrival_time": "2024-05-20T22:47:36Z", "origin_transport_type": "Bus", "origin_transport_name": "Sydney Buses Network", "origin_line_name": "195", "origin_line_name_short": "195", "changes": 1, "occupancy": "MANY_SEATS", "real_time_trip_id": "2096551", "latitude": -33.72665786743164, "longitude": 151.16305541992188}
         ```
+        
+        ```origin_line_name``` and ```origin_line_name_short``` are the fields that have the route filter applied, if present.  For buses they are usually the same, but for trains and ferries they generally show the full and short line names.  Both fields are checked and if either meet the filter then the journey is returned.
+        
         Fun fact:  TransportNSW's raw API output calls itself JSON, but it uses single quotes for strings in defiance of the JSON standards.  When using this wrapper the output is formatted such that `jq`, for example, is happy with it.
         
         * due: the time (in minutes) before the journey starts
@@ -76,7 +79,8 @@ 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 unless 'strict_transport_type' is True, in which case the first leg MUST be of the requested type to be returned.
+        
+        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.6.0 → PyTransportNSWv2-0.6.5}/PyTransportNSWv2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyTransportNSWv2
-Version: 0.6.0
+Version: 0.6.5
 Summary: Get detailed per-trip transport information from TransportNSW
 Home-page: https://github.com/andystewart999/TransportNSW
 Author: andystewart999
@@ -15,7 +15,7 @@ Description: # TransportNSWv2
         https://opendata.transport.nsw.gov.au/user-guide.  You need to register an application that needs both the Trip Planner and Realtime Vehicle Positions APIs
         
         ### Get the stop IDs
-        The function needs the stop IDs for the source and destination, and optionally how many minutes from now the departure should be, and if you want to filter trips by a specific transport type.  The easiest way to get the stop ID is via https://transportnsw.info/stops#/. It provides the option to search for either a location or a specific platform, bus stop or ferry wharf.  Regardless of if you specify a general location for the origin or destination, the return information shows the stop_id for the actual arrival and destination platform, bus stop or ferry wharf.
+        The function needs the stop IDs for the source and destination, and optionally how many minutes from now the departure should be, and if you want to filter trips by a specific transport type, or to only include trips that have specific text somewhere in the line/service details (see below).  The easiest way to get the stop ID is via https://transportnsw.info/stops#/. It provides the option to search for either a location or a specific platform, bus stop or ferry wharf.  Regardless of if you specify a general location for the origin or destination, the return information shows the stop_id for the actual arrival and destination platform, bus stop or ferry wharf.
         
         If it's available, the general occupancy level and the latitude and longitude of the selected journey's vehicle (train, bus, etc) will be returned.
         
@@ -24,7 +24,7 @@ Description: # TransportNSWv2
         
         ### Parameters
         ```python
-        .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] )
+        .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], [route_filter = ''] )
         ```
         
         Transport types:
@@ -58,6 +58,9 @@ Description: # TransportNSWv2
         ```python
         {"due": 3, "origin_stop_id": "207537", "origin_name": "Mona Vale Rd at Shinfield Ave, St Ives", "departure_time": "2024-05-20T21:59:48Z", "destination_stop_id": "2000338", "destination_name": "Central Station, Platform 18, Sydney", "arrival_time": "2024-05-20T22:47:36Z", "origin_transport_type": "Bus", "origin_transport_name": "Sydney Buses Network", "origin_line_name": "195", "origin_line_name_short": "195", "changes": 1, "occupancy": "MANY_SEATS", "real_time_trip_id": "2096551", "latitude": -33.72665786743164, "longitude": 151.16305541992188}
         ```
+        
+        ```origin_line_name``` and ```origin_line_name_short``` are the fields that have the route filter applied, if present.  For buses they are usually the same, but for trains and ferries they generally show the full and short line names.  Both fields are checked and if either meet the filter then the journey is returned.
+        
         Fun fact:  TransportNSW's raw API output calls itself JSON, but it uses single quotes for strings in defiance of the JSON standards.  When using this wrapper the output is formatted such that `jq`, for example, is happy with it.
         
         * due: the time (in minutes) before the journey starts
@@ -76,7 +79,8 @@ 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 unless 'strict_transport_type' is True, in which case the first leg MUST be of the requested type to be returned.
+        
+        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.6.0 → PyTransportNSWv2-0.6.5}/README.md

@@ -8,7 +8,7 @@ An OpenData account and API key is required to request the data. More informatio
 https://opendata.transport.nsw.gov.au/user-guide.  You need to register an application that needs both the Trip Planner and Realtime Vehicle Positions APIs
 
 ### Get the stop IDs
-The function needs the stop IDs for the source and destination, and optionally how many minutes from now the departure should be, and if you want to filter trips by a specific transport type.  The easiest way to get the stop ID is via https://transportnsw.info/stops#/. It provides the option to search for either a location or a specific platform, bus stop or ferry wharf.  Regardless of if you specify a general location for the origin or destination, the return information shows the stop_id for the actual arrival and destination platform, bus stop or ferry wharf.
+The function needs the stop IDs for the source and destination, and optionally how many minutes from now the departure should be, and if you want to filter trips by a specific transport type, or to only include trips that have specific text somewhere in the line/service details (see below).  The easiest way to get the stop ID is via https://transportnsw.info/stops#/. It provides the option to search for either a location or a specific platform, bus stop or ferry wharf.  Regardless of if you specify a general location for the origin or destination, the return information shows the stop_id for the actual arrival and destination platform, bus stop or ferry wharf.
 
 If it's available, the general occupancy level and the latitude and longitude of the selected journey's vehicle (train, bus, etc) will be returned.
 
@@ -17,7 +17,7 @@ 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], [strict_transport_type = True|False], [raw_output = True|False], [journeys_to_return = 1] )
+.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], [route_filter = ''] )
 ```
 
 Transport types:
@@ -51,6 +51,9 @@ print(journey)
 ```python
 {"due": 3, "origin_stop_id": "207537", "origin_name": "Mona Vale Rd at Shinfield Ave, St Ives", "departure_time": "2024-05-20T21:59:48Z", "destination_stop_id": "2000338", "destination_name": "Central Station, Platform 18, Sydney", "arrival_time": "2024-05-20T22:47:36Z", "origin_transport_type": "Bus", "origin_transport_name": "Sydney Buses Network", "origin_line_name": "195", "origin_line_name_short": "195", "changes": 1, "occupancy": "MANY_SEATS", "real_time_trip_id": "2096551", "latitude": -33.72665786743164, "longitude": 151.16305541992188}
 ```
+
+```origin_line_name``` and ```origin_line_name_short``` are the fields that have the route filter applied, if present.  For buses they are usually the same, but for trains and ferries they generally show the full and short line names.  Both fields are checked and if either meet the filter then the journey is returned.
+
 Fun fact:  TransportNSW's raw API output calls itself JSON, but it uses single quotes for strings in defiance of the JSON standards.  When using this wrapper the output is formatted such that `jq`, for example, is happy with it.
 
 * due: the time (in minutes) before the journey starts
@@ -69,7 +72,8 @@ 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 unless 'strict_transport_type' is True, in which case the first leg MUST be of the requested type to be returned.
+
+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.6.0 → PyTransportNSWv2-0.6.5}/TransportNSWv2/TransportNSWv2.py

@@ -71,7 +71,7 @@ class TransportNSWv2(object):
             }
 
     def get_trip(self, name_origin, name_destination , api_key, journey_wait_time = 0, transport_type = 0, \
-                 strict_transport_type = False, raw_output = False, journeys_to_return = 1):
+                 strict_transport_type = False, raw_output = False, journeys_to_return = 1, route_filter = ''):
         """Get the latest data from Transport NSW."""
         fmt = '%Y-%m-%dT%H:%M:%SZ'
 
@@ -83,6 +83,7 @@ class TransportNSWv2(object):
         self.strict_transport_type = strict_transport_type
         self.raw_output = raw_output
         self.journeys_to_return = journeys_to_return
+        self.route_filter = route_filter
 
         # This query always uses the current date and time - but add in any 'journey_wait_time' minutes
         now_plus_wait = datetime.now() + timedelta(minutes = journey_wait_time)
@@ -141,19 +142,14 @@ class TransportNSWv2(object):
         no_valid_journeys = False
 
         for current_journey_index in range (0, retrieved_journeys, 1):
-            if transport_type == 0:
-                # Just grab the next trip
-                journey = result['journeys'][current_journey_index]
-                next_journey_index = current_journey_index + 1
-            else:
-                # Look for a trip with a matching class filter in at least one of its legs.  Either ANY, or the first leg, depending on how strict we're being
-                journey, next_journey_index = self.find_next_journey(result['journeys'], current_journey_index, transport_type, strict_transport_type)
+            # Look for a trip with a matching transport type filter in at least one of its legs.  Either ANY, or the first leg, depending on how strict we're being
+            journey, next_journey_index = self.find_next_journey(result['journeys'], current_journey_index, transport_type, strict_transport_type, route_filter)
 
             if ((journey is None) or (journey['legs']) is None):
                 pass
             else:
                 legs = journey['legs']
-                first_leg = self.find_first_leg(legs, transport_type, strict_transport_type)
+                first_leg = self.find_first_leg(legs, transport_type, strict_transport_type, route_filter)
 
                 #Executive decision - don't be strict on the last leg, there's often some walking (transport type 100) involved.
                 last_leg = self.find_last_leg(legs, transport_type, False)
@@ -295,8 +291,8 @@ class TransportNSWv2(object):
 #        return None
 
 
-    def find_next_journey(self, journeys, start_journey_index, journeytype, strict):
-        # Fnd the next journey that has a leg of the requested type
+    def find_next_journey(self, journeys, start_journey_index, journeytype, strict, route_filter):
+        # Fnd the next journey that has a leg of the requested type, and/or that satisfies the route filter
         journey_count = len(journeys)
 
         # Some basic error checking
@@ -304,7 +300,7 @@ class TransportNSWv2(object):
             return None, None
 
         for journey_index in range (start_journey_index, journey_count, 1):
-            leg = self.find_first_leg(journeys[journey_index]['legs'], journeytype, strict)
+            leg = self.find_first_leg(journeys[journey_index]['legs'], journeytype, strict, route_filter)
             if leg is not None:
                 return journeys[journey_index], journey_index + 1
             else:
@@ -314,22 +310,32 @@ class TransportNSWv2(object):
         return None, None
 
 
-    def find_first_leg(self, legs, legtype, strict):
+    def find_first_leg(self, legs, legtype, strict, route_filter):
         # Find the first leg of the requested type
         leg_count = len(legs)
         for leg_index in range (0, leg_count, 1):
-            leg_class = legs[leg_index]['transportation']['product']['class']
-            # We've got a filter, and the leg type matches it, so return that leg
-            if legtype != 0 and leg_class == legtype:
-                return legs[leg_index]
-
-            # We don't have a filter, and this is the first non-walk/cycle leg so return that leg
-            if  legtype == 0 and leg_class < 99:
-                return legs[leg_index]
-
-            # Exit if we're doing strict filtering and we haven't found that type in the first leg
-            if legtype != 0 and strict == True:
-                return None
+            #First, check against the route filter
+            origin_line_name_short = 'n/a'
+            origin_line_name = 'n/a'
+
+            if 'transportation' in legs[leg_index]:
+                if 'disassembledName' in legs[leg_index]['transportation']:
+                    origin_line_name_short = legs[leg_index]['transportation']['disassembledName']
+                    origin_line_name = legs[leg_index]['transportation']['number']
+
+            if (route_filter in origin_line_name_short or route_filter in origin_line_name):
+                leg_class = legs[leg_index]['transportation']['product']['class']
+                # We've got a filter, and the leg type matches it, so return that leg
+                if legtype != 0 and leg_class == legtype:
+                    return legs[leg_index]
+
+                # We don't have a filter, and this is the first non-walk/cycle leg so return that leg
+                if  legtype == 0 and leg_class < 99:
+                    return legs[leg_index]
+
+                # Exit if we're doing strict filtering and we haven't found that type in the first leg
+                if legtype != 0 and strict == True:
+                    return None
 
         # Hmm, we didn't find one
         return None

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

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