PyTransportNSWv2 0.2.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

{PyTransportNSWv2-0.2.3.dist-info → PyTransportNSWv2-0.3.0.dist-info}/METADATA

@@ -1,17 +1,16 @@
 Metadata-Version: 2.1
 Name: PyTransportNSWv2
-Version: 0.2.3
+Version: 0.3.0
 Summary: Get detailed per-trip transport information from TransportNSW
 Home-page: https://github.com/andystewart999/TransportNSW
 Author: andystewart999
-License: UNKNOWN
-Platform: UNKNOWN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: gtfs-realtime-bindings
 
 # TransportNSW
@@ -29,47 +28,47 @@ The library needs the stop ID for the source and destination, and optionally how
 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.
 
 ### API Documentation
-The source API details can be found here: https://opendata.transport.nsw.gov.au/node/601/exploreapi
+The source API details can be found here: https://opendata.transport.nsw.gov.au/sites/default/files/2023-08/Trip%20Planner%20API%20manual-opendataproduction%20v3.2.pdf
 
 ### Parameters
 ```python
 .get_trip(origin_stop_id, destination_stop_id, api_key, [trip_wait_time = 0])
 ```
 
+TransportNSW's trip planner works much better if you use the general location IDs (eg Central Station) rather than a specific platform id (eg Central Station, Platform 19).  Forcing a specific platform sometimes results in much more complicated trips.
+
 ### Sample Code
-The following example will return the next trip from Gordon Station to Pymble Station, without specifying a platform.
+The following example will return the next trip from a bus stop in St. Ives to Central Station, without specifying a specific destination platform.
 
 **Code:**
 ```python
 from TransportNSW import TransportNSW
 tnsw = TransportNSW()
-journey = tnsw.get_trip('10101121', '10101123', 'YOUR_API_KEY')
+journey = tnsw.get_trip('207537', '10101100', 'YOUR_API_KEY')
 print(journey)
 ```
 **Result:**
 ```python
-{'due': 5, 'origin_stop_id': '207263', 'origin_name': 'Gordon Station', 'origin_detail': 'Platform 3', 'departure_time': '2020-06-14T10:21:30Z', 'destination_stop_id': '2073162', 'destination_name': 'Pymble Station', 'destination_detail': 'Platform 2', 'arrival_time': '2020-06-14T10:23:30Z', 'transport_type': 'Train', 'transport_name': 'Sydney Trains Network', 'line_name': 'T1 North Shore & Western Line', 'line_name_short': 'T1', 'occupancy': 'UNKNOWN', 'real_time_trip_id': '104P.1379.110.128.T.8.61720413', 'latitude': -33.76505661010742, 'longitude': 151.1614227294922}
+{'due': 23, 'origin_stop_id': '207537', 'origin_name': 'St Ives, Mona Vale Rd at Shinfield Ave', 'departure_time': '2020-06-28T10:10:00Z', 'destination_stop_id': '2000338', 'destination_name': 'Sydney, Central Station, Platform 18', 'arrival_time': '2020-06-28T11:02:00Z', 'origin_transport_type': 'Bus', 'origin_transport_name': 'Sydney Buses Network', 'origin_line_name': '195', 'origin_line_name_short': '195', 'changes': 1, 'occupancy': 'UNKNOWN', 'real_time_trip_id': '612993', 'latitude': 'n/a', 'longitude': 'n/a'}
 ```
 
-* due: the time (in minutes) before the vehicle arrives 
+* due: the time (in minutes) before the journey starts 
 * origin_stop_id: the specific departure stop id
-* origin_name: the name of the general departure location
-* origin_detail: the specific departure location
+* origin_name: the name of the departure location
+* departure_time: the departure time
+* destination_stop_id: the specific destination stop id
+* destination_name: the name of the destination location
 * arrival_time: the arrival time at the origin
-* transport_type: the type of transport, eg train, bus, ferry etc
-* transport_name: the full name of transport providere
-* line_name & line_name_short: the full and short names of the journey
-* occupancy: how full the vehicle is
+* origin_transport_type: the type of transport, eg train, bus, ferry etc
+* origin_transport_name: the full name of transport providere
+* origin_line_name & origin_line_name_short: the full and short names of the journey
+* changes: how many transport changes are needed
+* occupancy: how full the vehicle is, if available
 * real_time_trip_id: the unique TransportNSW id for that specific journey
 * latitude & longitude: The location of the vehicle, if available
 
-### To do: 
-* Add an option to filter by specific transport type, useful if the general departure and arrival ids are being used
-* Add an option to show brief vs verbose information
+Please note that the origin and destination detail is just that.  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.
 
 ## 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!
-
 https://github.com/Dav0815/TransportNSW
-
-

PyTransportNSWv2-0.3.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+TransportNSW/TransportNSW.py,sha256=jjuFpL2FqIKAmDE0IvgULzLqO1QZ4tE-wrUHTYs9iwY,12930
+TransportNSW/__init__.py,sha256=O3iuSkUGkkDz4C7IlqvOXJHPJTxYz0q_48-94ESlkdg,86
+PyTransportNSWv2-0.3.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+PyTransportNSWv2-0.3.0.dist-info/METADATA,sha256=86_6bT24mMIYXlUWzLlEZ97fgyG3I9gdgokDcsMy2sU,4500
+PyTransportNSWv2-0.3.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+PyTransportNSWv2-0.3.0.dist-info/top_level.txt,sha256=C4LQEkr85VJtG9cklBu9IFpSKRaNSADPBTSPeXIYnOw,13
+PyTransportNSWv2-0.3.0.dist-info/RECORD,,

{PyTransportNSWv2-0.2.3.dist-info → PyTransportNSWv2-0.3.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.34.2)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

TransportNSW/TransportNSW.py

@@ -46,6 +46,7 @@ class TransportNSW(object):
         self.destination_id = None
         self.api_key = None
         self.trip_wait_time = None
+        self.transport_type = None
         self.info = {
             ATTR_DUE_IN : 'n/a',
             ATTR_ORIGIN_STOP_ID : 'n/a',
@@ -65,7 +66,7 @@ class TransportNSW(object):
             ATTR_LONGITUDE : 'n/a'
             }
 
-    def get_trip(self, name_origin, name_destination , api_key, trip_wait_time = 0):
+    def get_trip(self, name_origin, name_destination , api_key, trip_wait_time = 0, transport_type = 0):
         """Get the latest data from Transport NSW."""
         fmt = '%Y-%m-%dT%H:%M:%SZ'
 
@@ -73,12 +74,20 @@ class TransportNSW(object):
         self.destination = name_destination
         self.api_key = api_key
         self.trip_wait_time = trip_wait_time
+        self.transport_type = transport_type
 
         # This query always uses the current date and time - but add in any 'trip_wait_time' minutes
         now_plus_wait = datetime.now() + timedelta(minutes = trip_wait_time)
         itdDate = now_plus_wait.strftime('%Y%m%d')
         itdTime = now_plus_wait.strftime('%H%M')
 
+        if transport_type == 0:
+            # We only need to retrieve one trip - a transport type filter hasn't been applied
+            numberOfTrips = 1
+        else:
+            # 5 trips seems like a safe number
+            numberOfTrips = 5
+
         # Build the entire URL
         url = \
             'https://api.transport.nsw.gov.au/v1/tp/trip?' \
@@ -86,7 +95,9 @@ class TransportNSW(object):
             '&depArrMacro=dep&itdDate=' + itdDate + '&itdTime=' + itdTime + \
             '&type_origin=any&name_origin=' + name_origin + \
             '&type_destination=any&name_destination=' + name_destination + \
-            '&calcNumberOfTrips=1&TfNSWDM=true&version=10.2.1.42'
+            '&calcNumberOfTrips=' + str(numberOfTrips) + \
+            '&TfNSWTR=true'
+
         auth = 'apikey ' + self.api_key
         header = {'Accept': 'application/json', 'Authorization': auth}
 
@@ -106,21 +117,28 @@ class TransportNSW(object):
 
         # Parse the result as a JSON object
         result = response.json()
-        print (result)
 
         # The API will always return a valid trip, so it's just a case of grabbing what we need...
         # We're only reporting on the origin and destination, it's out of scope to discuss the specifics of the ENTIRE journey
         # This isn't a route planner, just a 'how long until the next journey I've specified' tool
         # The assumption is that the travelee will know HOW to make the defined journey, they're just asking WHEN it's happening next
+        # All we potentially have to do is find the first trip that matches the transport_type filter
+
+        if transport_type == 0:
+            # Just grab the first (and only) trip
+            journey = result['journeys'][0]
+        else:
+            # Look for a trip with a matching class filter in at least one of its legs.  Could possibly be more stringent here, if ANY part of the journey fits the filter, it will be returned.
+            journey = self.find_first_journey(result['journeys'], transport_type)
 
-        legs = result['journeys'][0]['legs']
-        first_leg = self.find_first_leg(legs)
-        last_leg = self.find_last_leg(legs)
-        changes = self.find_changes(legs)
+        legs = journey['legs']
+        first_leg = self.find_first_leg(legs, transport_type)
+        last_leg = self.find_last_leg(legs, transport_type)
+        changes = self.find_changes(legs, transport_type)
 
         origin = result['journeys'][0]['legs'][first_leg]['origin']
         # probably tidy this up when we start to get occupancy data back
-        first_destination = result['journeys'][0]['legs'][first_leg]['destination']
+        first_stop = result['journeys'][0]['legs'][first_leg]['destination']
         destination = result['journeys'][0]['legs'][last_leg]['destination']
         transportation = result['journeys'][0]['legs'][first_leg]['transportation']
 
@@ -155,9 +173,9 @@ class TransportNSW(object):
 
         # Occupancy info, if it's there
         occupancy = 'UNKNOWN'
-        if 'properties' in first_destination:
-            if 'occupancy' in first_destination['properties']:
-                occupancy = first_destination['properties']['occupancy']
+        if 'properties' in first_stop:
+            if 'occupancy' in first_stop['properties']:
+                occupancy = first_stop['properties']['occupancy']
 
         # Now might be a good time to see if we can also find the latitude and longitude
         # Using the Realtime Vehicle Positions API
@@ -226,43 +244,51 @@ class TransportNSW(object):
             }
         return self.info
 
+    def find_first_journey(self, journeys, journeytype):
+        # Find the first journey whose first leg is of the requested type
+        journey_count = len(journeys)
+        for journey in range (0, journey_count, 1):
+            leg = self.find_first_leg(journeys[journey]['legs'], journeytype)
+            if leg is not None:
+                return journeys[journey]
 
-    def find_first_leg(self, legs):
-        # Find the first non-footpath leg
+        # Hmm, we didn't find one
+        return None
+
+
+    def find_first_leg(self, legs, legtype):
+        # Find the first leg of the requested type
         leg_count = len(legs)
         for leg in range (0, leg_count, 1):
             leg_class = legs[leg]['transportation']['product']['class']
-            #print (leg_class)
-            if leg_class < 100:
-                # 100 is the class for walking, anything less is a train, bus, etc
+
+            if leg_class == legtype or legtype == 0:
                 return leg
 
         # Hmm, we didn't find one
         return None
 
 
-    def find_last_leg(self, legs):
-        # Find the last non-footpath leg
+    def find_last_leg(self, legs, legtype):
+        # Find the last leg of the requested type
         leg_count = len(legs)
-        for leg in range (leg_count-1, 0, -1):
+        for leg in range (leg_count - 1, -1, -1):
             leg_class = legs[leg]['transportation']['product']['class']
-            #print (leg_class)
-            if leg_class < 100:
-                # 100 is the class for walking, anything less is a train, bus, etc
+
+            if leg_class == legtype or legtype == 0:
                 return leg
 
         # Hmm, we didn't find one
         return None
 
-    def find_changes(self, legs):
+    def find_changes(self, legs, legtype):
         # Find out how often we have to change
         changes = 0
         leg_count = len(legs)
 
         for leg in range (0, leg_count, 1):
             leg_class = legs[leg]['transportation']['product']['class']
-            if leg_class < 100:
-                # 100 is the class for walking, anything less is a train, bus, etc
+            if leg_class == legtype or legtype == 0:
                 changes = changes + 1
 
         return changes - 1
@@ -276,7 +302,10 @@ class TransportNSW(object):
             5: "Bus",
             7: "Coach",
             9: "Ferry",
-            11: "School bus"
+            11: "School bus",
+            99: "Walk",
+            100: "Walk",
+            107: "Cycle"
         }
         return modes.get(iconId, None)
 

PyTransportNSWv2-0.2.3.dist-info/RECORD

@@ -1,8 +0,0 @@
-TransportNSW/TransportNSW.py,sha256=MMWtgjnE6-YQirVRO9O7wYABAXvys_aygg6s3dglbeA,11754
-TransportNSW/__init__.py,sha256=O3iuSkUGkkDz4C7IlqvOXJHPJTxYz0q_48-94ESlkdg,86
-TransportNSW/test.py,sha256=S9t1Tdz_Q1xbTPjCNgr5bFDPWgJgBHjNLMESx8xI7Ag,961
-PyTransportNSWv2-0.2.3.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-PyTransportNSWv2-0.2.3.dist-info/METADATA,sha256=iisyfIwofXBEXQNf9aTb8lZ_xW9CpMnMtjjr8MbWAGs,3792
-PyTransportNSWv2-0.2.3.dist-info/WHEEL,sha256=g4nMs7d-Xl9-xC9XovUrsDHGXt-FT0E17Yqo92DEfvY,92
-PyTransportNSWv2-0.2.3.dist-info/top_level.txt,sha256=C4LQEkr85VJtG9cklBu9IFpSKRaNSADPBTSPeXIYnOw,13
-PyTransportNSWv2-0.2.3.dist-info/RECORD,,

TransportNSW/test.py

@@ -1,28 +0,0 @@
-from TransportNSW import TransportNSW
-tnsw = TransportNSW()
-
-sApiKey = 'oWwCalKSy0ZQB5JTw7sTXlcaOjv01fto1W3v'
-#sStopId = '207261'   #Gordon, platform 1
-sStopId = '10101121' #Gordon station
-#sDestId = '10101122' #Pymble station
-#sStopId = '2000336'  #Central, platform 16
-#sDestId = '2015137' #Redfern, platform 7
-#sStopId = '2015133'  #Redfern, platform 11
-#sStopId = '207248'   # Gordon bus stop
-#sDestId = '207537'   # St Ives stop
-#sDestId = '2073161'  #Pymble station
-#sStopId = '2000225'   # Circular Quay Wharf 4
-#sDestId = '20883'     # Taronga Zoo Wharf
-#sStopId = '20461'     # Abbotsford
-#sDestId = '2137186'   # Cabarita
-sDestId = '10101100'  # Central
-#sDestId = '10101421'   # Redfern
-
-sStopId = 'streetID:1500000021:8:95330012:1:Coree Pl:St Ives:Coree Pl::Coree Pl:2075:ANY:DIVA_SINGLEHOUSE:4885970:3740665:GDAV:nsw'
-sDestId = '10101100'
-
-nMinDueTime = 0
-
-journey = tnsw.get_trip(sStopId, sDestId, sApiKey, nMinDueTime)
-print (' ')
-print(journey)