PyTransportNSWv2 0.3.1__py3-none-any.whl → 0.3.4__py3-none-any.whl

{PyTransportNSWv2-0.3.1.dist-info → PyTransportNSWv2-0.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyTransportNSWv2
-Version: 0.3.1
+Version: 0.3.4
 Summary: Get detailed per-trip transport information from TransportNSW
 Home-page: https://github.com/andystewart999/TransportNSW
 Author: andystewart999
@@ -12,6 +12,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: gtfs-realtime-bindings
+Requires-Dist: requests
 
 # TransportNSW
 Python lib to access Transport NSW information.
@@ -34,9 +35,21 @@ The source API details can be found here: https://opendata.transport.nsw.gov.au/
 ```python
 .get_trip(origin_stop_id, destination_stop_id, api_key, [trip_wait_time = 0], [transport_type = 0])
 ```
-
 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.
 
+### transport_type filters
+```
+1: Train
+4: Light rail
+5: Bus
+7: Coach
+9: Ferry
+11: School bus
+99: Walk
+100: Walk
+107: Cycle
+```
+
 ### Sample Code
 
 The following example will return the next trip that starts from a bus stop in St. Ives (207537) five minutes from now, to Central Station's general stop ID (10101100):
@@ -52,7 +65,7 @@ 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}
 ```
-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.
+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
 * origin_stop_id: the specific departure stop id

PyTransportNSWv2-0.3.4.dist-info/RECORD

@@ -0,0 +1,7 @@
+TransportNSW/TransportNSW.py,sha256=AbgpP6PgHqVjB7LhNI9cT3q7O9ySUMnI057k7mmYLyQ,13926
+TransportNSW/__init__.py,sha256=O3iuSkUGkkDz4C7IlqvOXJHPJTxYz0q_48-94ESlkdg,86
+PyTransportNSWv2-0.3.4.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+PyTransportNSWv2-0.3.4.dist-info/METADATA,sha256=vN1ZaUheTpFBEe_mj1aERCNP3ecrGmPGFCOsn0VizYU,5481
+PyTransportNSWv2-0.3.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+PyTransportNSWv2-0.3.4.dist-info/top_level.txt,sha256=C4LQEkr85VJtG9cklBu9IFpSKRaNSADPBTSPeXIYnOw,13
+PyTransportNSWv2-0.3.4.dist-info/RECORD,,

TransportNSW/TransportNSW.py

@@ -157,7 +157,7 @@ class TransportNSW(object):
         origin_name = origin['name']
         origin_departure_time = origin['departureTimeEstimated']
 
-	# How long until it leaves?
+        # How long until it leaves?
         due = self.get_due(datetime.strptime(origin_departure_time, fmt))
 
         # Destination info
@@ -276,7 +276,12 @@ class TransportNSW(object):
         for leg in range (0, leg_count, 1):
             leg_class = legs[leg]['transportation']['product']['class']
 
-            if leg_class == legtype or legtype == 0:
+            # We've got a filter, and the leg type matches it, so return it
+            if legtype != 0 and leg_class == legtype:
+                return leg
+                
+            # We don't have a filter, and this is the first non-walk/cycle leg so return it
+            if  legtype == 0 and leg_class < 99:
                 return leg
 
         # Hmm, we didn't find one
@@ -289,7 +294,12 @@ class TransportNSW(object):
         for leg in range (leg_count - 1, -1, -1):
             leg_class = legs[leg]['transportation']['product']['class']
 
-            if leg_class == legtype or legtype == 0:
+            # We've got a filter, and the leg type matches it, so return it
+            if legtype != 0 and leg_class == legtype:
+                return leg
+                
+            # We don't have a filter, and this is the first non-walk/cycle leg so return it
+            if  legtype == 0 and leg_class < 99:
                 return leg
 
         # Hmm, we didn't find one

PyTransportNSWv2-0.3.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-TransportNSW/TransportNSW.py,sha256=dKbYIRSLJUqmJHDH5ZOdLWK5mObW4uxGb89l1Um9_-k,13395
-TransportNSW/__init__.py,sha256=O3iuSkUGkkDz4C7IlqvOXJHPJTxYz0q_48-94ESlkdg,86
-PyTransportNSWv2-0.3.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-PyTransportNSWv2-0.3.1.dist-info/METADATA,sha256=fFZtnw4SXZZfkjGktIEW29Qaj3Re0QDPmxXfGmM2ddk,5326
-PyTransportNSWv2-0.3.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-PyTransportNSWv2-0.3.1.dist-info/top_level.txt,sha256=C4LQEkr85VJtG9cklBu9IFpSKRaNSADPBTSPeXIYnOw,13
-PyTransportNSWv2-0.3.1.dist-info/RECORD,,