PyTransportNSWv2 0.8.2__tar.gz → 0.8.4__tar.gz

{PyTransportNSWv2-0.8.2 → PyTransportNSWv2-0.8.4}/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: PyTransportNSWv2
-Version: 0.8.2
+Version: 0.8.4
 Summary: Get detailed per-trip transport information from TransportNSW
 Home-page: https://github.com/andystewart999/TransportNSW
 Author: andystewart999
+Author-email: andy.stewart@live.com
 License: UNKNOWN
 Description: # TransportNSWv2
         Python lib to access Transport NSW information.
@@ -146,6 +147,9 @@ Description: # TransportNSWv2
         
         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.
         
+        ### Rate limits ###
+        By default the TransportNSW API allows each API key to make 60,000 calls in a day and up to 5 calls per second.  Usually this wouldn't be an issue but if you're requesting real-time location data for buses, because I haven't found an elegant way to map the bus route to the correct API URL (and there are about 14) it's brute-forcing it by iterating through ALL the possible URLs until it finds the appropriate journey or it runs out of URLs.  From version 0.8.2 I've added in a 0.5 second delay between loops until I can find a better approach.
+        
         ## 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.8.2 → PyTransportNSWv2-0.8.4}/PyTransportNSWv2.egg-info/PKG-INFO

@@ -1,9 +1,10 @@
 Metadata-Version: 2.1
 Name: PyTransportNSWv2
-Version: 0.8.2
+Version: 0.8.4
 Summary: Get detailed per-trip transport information from TransportNSW
 Home-page: https://github.com/andystewart999/TransportNSW
 Author: andystewart999
+Author-email: andy.stewart@live.com
 License: UNKNOWN
 Description: # TransportNSWv2
         Python lib to access Transport NSW information.
@@ -146,6 +147,9 @@ Description: # TransportNSWv2
         
         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.
         
+        ### Rate limits ###
+        By default the TransportNSW API allows each API key to make 60,000 calls in a day and up to 5 calls per second.  Usually this wouldn't be an issue but if you're requesting real-time location data for buses, because I haven't found an elegant way to map the bus route to the correct API URL (and there are about 14) it's brute-forcing it by iterating through ALL the possible URLs until it finds the appropriate journey or it runs out of URLs.  From version 0.8.2 I've added in a 0.5 second delay between loops until I can find a better approach.
+        
         ## 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.8.2 → PyTransportNSWv2-0.8.4}/README.md

@@ -139,6 +139,9 @@ Note also that the origin and destination details are just that - information ab
 
 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.
 
+### Rate limits ###
+By default the TransportNSW API allows each API key to make 60,000 calls in a day and up to 5 calls per second.  Usually this wouldn't be an issue but if you're requesting real-time location data for buses, because I haven't found an elegant way to map the bus route to the correct API URL (and there are about 14) it's brute-forcing it by iterating through ALL the possible URLs until it finds the appropriate journey or it runs out of URLs.  From version 0.8.2 I've added in a 0.5 second delay between loops until I can find a better approach.
+
 ## 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.8.2 → PyTransportNSWv2-0.8.4}/TransportNSWv2/TransportNSWv2.py

@@ -9,6 +9,7 @@ import requests
 import logging
 import re
 import json #For the output
+import time
 
 ATTR_DUE_IN = 'due'
 
@@ -120,7 +121,11 @@ class TransportNSWv2(object):
 
             # If we get bad status code, log error and return with n/a or an empty string
             if response.status_code != 200:
-                logger.error("Error calling /v1/tp/stop_finder API; check api key")
+                if response.status_code == 429:
+                    logger.error("Error " + str(response.status_code) + " calling /v1/tp/stop_finder API; rate limit exceeded")
+                else:
+                    logger.error("Error " + str(response.status_code) + " calling /v1/tp/stop_finder API; check api key")
+
                 return None
 
             # Parse the result as a JSON object
@@ -130,6 +135,10 @@ class TransportNSWv2(object):
             if 'systemMessages' in result:
                 logger.error("Stop ID " + stop + " does not exist")
 
+            # Put in a quick pause here to try and make sure we stay under the 5 minute calls/second limit
+            # Not usually an issue but if multiple processes are running multiple calls we might hit it
+            time.sleep(0.5)
+
         # We don't control how many journeys are returned any more, so need to be careful of running out of valid journeys if there is a filter in place, particularly a strict filter
         # It would be more efficient to return one journey, check if the filter is met and then retrieve the next one via a new query if not, but for now we'll only be making use of the journeys we've been given
 
@@ -154,7 +163,7 @@ class TransportNSWv2(object):
 
         # If we get bad status code, log error and return with n/a or an empty string
         if response.status_code != 200:
-            logger.error("Error with the request sent; check api key")
+            logger.error("Error " + str(response.status_code) + " calling /v1/tp/trip API; check api key")
             return None
 
         # Parse the result as a JSON object
@@ -207,8 +216,6 @@ class TransportNSWv2(object):
                 t2 = datetime.strptime(origin_departure_time_planned, fmt).timestamp()
                 delay = int((t1-t2) / 60)
 
-                #print (origin_departure_time - origin_departure_time_planned)
-
                 # How long until it leaves?
                 due = self.get_due(datetime.strptime(origin_departure_time, fmt))
 
@@ -289,6 +296,13 @@ class TransportNSWv2(object):
                             break
 
 
+                        # Put in a quick pause here to try and make sure we stay under the 5 minute calls/second limit
+                        # Not usually an issue but if multiple processes are running multiple calls we might hit it
+                        time.sleep(0.5)
+
+
+
+
                 self.info = {
                     ATTR_DUE_IN: due,
                     ATTR_DELAY: delay,
@@ -454,14 +468,7 @@ class TransportNSWv2(object):
             current_leg = legs[leg_index]
             leg_class = current_leg['transportation']['product']['class']
             if 'hints' in current_leg:
-                #print ("")
-                #print ("Found hint(s) for leg " + str(leg_index) )
                 hints = current_leg['hints']
-                #for hint in hints:
-                    #print ("Hint:")
-                    #print (hint)
-                    #print (" ")
-
 
 
     def get_mode(self, iconId):

{PyTransportNSWv2-0.8.2 → PyTransportNSWv2-0.8.4}/setup.py

@@ -5,8 +5,9 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="PyTransportNSWv2",
-    version="0.8.2",
+    version="0.8.4",
     author="andystewart999",
+    author_email="andy.stewart@live.com",
     description="Get detailed per-trip transport information from TransportNSW",
     long_description=long_description,
     long_description_content_type="text/markdown",